Yassine Guedidi
c4b52d746c
Refresh the asynchronous, backup, installation, permissions, and user-configuration pages so they describe the current environment-variable setup and remove stale references to parameters.yml as the active configuration path. These edits are derivative of the new Parameters reference rather than part of that contract itself. Keeping them last lets reviewers check the broad cleanup once the authoritative documentation is already settled.
4.8 KiB
title, weight
| title | weight |
|---|---|
| Installation | 2 |
On a dedicated web server (recommended way)
To install wallabag itself, you must run the following commands:
git clone https://github.com/wallabag/wallabag.git
cd wallabag && make install
If it's your first installation, you can safely answer "yes" when asking to reset the database.
Now, read the next step to create your virtual host, then access your wallabag.
{{< callout type="info" >}}
wallabag is configured with environment variables. For local development, put
overrides in .env.local. For production, export the variables through your
web server, PHP-FPM, or container runtime. See
[Parameters]({{< relref "../parameters.md" >}}) for the full list.
{{< /callout >}}
{{< callout type="info" >}}
If you want to use SQLite to store your data, set
DATABASE_URL=sqlite:///%kernel.project_dir%/data/db/wallabag.sqlite.
{{< /callout >}}
{{< callout type="info" >}}
If you're installing wallabag behind Squid as a reverse proxy, make sure to update your squid.conf configuration to include login=PASS in the cache_peer line. This is necessary for API calls to work properly.
{{< /callout >}}
On shared hosting
We provide a package with all dependencies inside. The default
configuration uses MySQL for the database. Configure the environment variables
documented on the [Parameters]({{< relref "../parameters.md" >}}) page before
running the installer. If you are upgrading an older deployment that still has
app/config/parameters.yml, wallabag will keep reading it with a deprecation
warning until wallabag 3.0.
We have already created a user: the login and password are wallabag.
With this package, wallabag doesn't check for mandatory extensions used
in the application (these checks are made during composer install
when you have a dedicated web server, see above).
Execute this command to download and extract the latest package:
wget https://wllbg.org/latest-v2-package && tar xvf latest-v2-package
You will find the md5 hash of the latest package on our website.
The static package requires each command to be appended by --env=prod as the static package is only usable as a prod environment (dev environment is not supported and won't work at all).
Now, read the next step to create your virtual host.
You must create your first user by using the command php bin/console wallabag:install --env=prod
If an error occurs at this step due to bad settings, you must clear the cache with php bin/console cache:clear --env=prod before you try again the previous command.
Then you can access your wallabag.
Usage of wallabag.it
wallabag.it is a paid service to use wallabag without installing it on a web server.
This service always ships the latest release of wallabag. You can create your account here. Try it for free: you'll get a 14-day free trial with no limitation (no credit card information required).
Installation with Docker or Docker compose
Command to launch container
This example starts wallabag at http://localhost:8080 using SQLite backend and persists its data to Docker named volumes:
docker run \
-v wallabag-data:/var/www/wallabag/data \
-v wallabag-images:/var/www/wallabag/web/assets/images \
-p 8080:80 \
-e APP_SECRET=change-me \
-e WALLABAG_BASE_URL=http://localhost:8080 \
-e DATABASE_URL=sqlite:////var/www/wallabag/data/db/wallabag.sqlite \
wallabag/wallabag
The default username and password are wallabag:wallabag. For more information, see wallabag on Docker Hub.
Installation on Cloudron
Cloudron provides an easy way to install webapps on your server with a focus on sysadmin automation and keeping apps updated. wallabag is packaged as a Cloudron app and available to install directly from the store.
Install wallabag on your Cloudron
Installation on YunoHost
YunoHost provides an easy way to install webapps on your server with a focus on sysadmin automation and keeping apps updated. wallabag is packaged as an official YunoHost app and is available to install directly from the official repository.
Installation on alwaysdata
alwaysdata's Marketplace allows to easily install wallabag (and many other applications) on a Public or Private Cloud.
Install wallabag on alwaysdata
Installation on Synology
The SynoCommunity provides a package to install wallabag on your Synology NAS.