Skip to content

Latest commit

 

History

History
101 lines (68 loc) · 3.63 KB

installation.md

File metadata and controls

101 lines (68 loc) · 3.63 KB

Installation

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

Now, read the following documentation to create your virtual host, then access your wallabag.

{% hint style="info" %} To define parameters with environment variables, you have to set these variables with SYMFONY__ prefix, for example, SYMFONY__DATABASE_DRIVER. You can have a look at Symfony documentation. {% endhint %}

{% hint style="tip" %} If you want to use SQLite to store your data, please put %kernel.root_dir%/../data/db/wallabag.sqlite for the database_path parameter during installation. {% endhint %}

{% hint style="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. {% endhint %}

On shared hosting

We provide a package with all dependencies inside. The default configuration uses MySQL for the database. If you want to change these settings, please edit app/config/parameters.yml.

With this package, wallabag doesn't check for mandatory extensions used in the application (theses 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.

Now, read the following documentation to create your virtual host, then access your wallabag.

To create a new user, please use the register form. Then, in order to have admin permissions, please run this query in your favorite DMBS (by replacing 1 with the id for this new user):

UPDATE wallabag_user SET roles = 'a:2:{i:0;s:9:"ROLE_USER";i:1;s:16:"ROLE_SUPER_ADMIN";}' where id = 1;

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

We provide you a Docker image to install wallabag easily. Have a look at our repository on Docker Hub for more information.

Command to launch container

docker pull wallabag/wallabag

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.

Install wallabag with YunoHost

Installation on Synology

The SynoCommunity provides a package to install wallabag on your Synology NAS.

Install wallabag with Synology