Merge pull request #297 from wallabag/release/2.5.2

2.5.2

.github/dependabot.yml

@@ -0,0 +1,14 @@
+version: 2
+updates:
+- package-ecosystem: docker
+  directory: "/"
+  schedule:
+    interval: daily
+    time: "04:00"
+    timezone: Europe/Paris
+  open-pull-requests-limit: 10
+  ignore:
+  - dependency-name: alpine
+    versions:
+    - ">= 3.11.a"
+    - "< 3.12"

.github/workflows/publish.yml

@@ -0,0 +1,57 @@
+name: Publish Docker image
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  push_to_registries:
+    name: Push Docker image to multiple registries
+    runs-on: ubuntu-latest
+    permissions:
+      packages: write
+      contents: read
+    steps:
+      - name: Check out the repo
+        uses: actions/checkout@v2
+
+      - name: Log in to Docker Hub
+        uses: docker/login-action@v1
+        with:
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_PASSWORD }}
+
+      - name: Log in to the Container registry
+        uses: docker/login-action@v1
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+          
+       # Documentation: https://github.com/docker/setup-qemu-action
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v1
+        
+      # Documentation: https://github.com/docker/setup-buildx-action
+      - name: Set up Docker Buildx
+        id: buildx
+        uses: docker/setup-buildx-action@v1
+
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta
+        uses: docker/metadata-action@v3
+        with:
+          images: |
+            wallabag/wallabag
+            ghcr.io/${{ github.repository }}
+
+      - name: Build and push Docker images
+        uses: docker/build-push-action@v2
+        with:
+          context: .
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+          # Support for different platforms, see here: 
+          # https://github.com/docker/buildx/blob/master/docs/reference/buildx_build.md#-set-the-target-platforms-for-the-build---platform
+          platforms: linux/amd64,linux/arm64,linux/arm/v7

.github/workflows/test.yml

@@ -0,0 +1,54 @@
+name: "CI"
+
+on:
+  pull_request:
+    branches:
+      - "master"
+  push:
+    branches:
+      - "master"
+
+jobs:
+  test:
+    name: "Testing with database: ${{ matrix.database }}"
+    runs-on: "ubuntu-latest"
+
+    strategy:
+      fail-fast: false
+      matrix:
+        database:
+          - "default"
+          - "sqlite"
+          - "mariadb"
+          - "postgresql"
+
+    steps:
+      - name: "Checkout"
+        uses: "actions/checkout@v2"
+        with:
+          fetch-depth: 2
+
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.5
+
+      - name: "Build image"
+        run: docker-compose -f tests/docker-compose.${{ matrix.database }}.yml build
+
+      - name: "Run image"
+        run: docker-compose -f tests/docker-compose.${{ matrix.database }}.yml up -d
+
+      - name: "Install dependencies"
+        run: |
+          pip install pytest
+          pip install requests
+
+      - name: "Check running instance"
+        run: docker ps
+
+      - name: "Wait 60s"
+        run: sleep 60
+
+      - name: "Run tests"
+        run: py.test tests/

.gitignore

@@ -0,0 +1,3 @@
+.cache
+__pycache__/*
+*.pyc

Dockerfile

@@ -1,70 +1,72 @@
-FROM alpine:edge
-MAINTAINER Marvin Steadfast <marvin@xsteadfastx.org>
+FROM alpine:3.15
 
-ENV WALLABAG_VERSION=2.0.6 \
-    SYMFONY__ENV__DATABASE_DRIVER=pdo_sqlite \
-    SYMFONY__ENV__DATABASE_HOST=127.0.0.1 \
-    SYMFONY__ENV__DATABASE_PORT=~ \
-    SYMFONY__ENV__DATABASE_NAME=symfony \
-    SYMFONY__ENV__DATABASE_USER=root \
-    SYMFONY__ENV__DATABASE_PASSWORD=~ \
-    SYMFONY__ENV__SECRET=ovmpmAWXRCabNlMgzlzFXDYmCFfzGv \
-    SYMFONY__ENV__MAILER_HOST=127.0.0.1 \
-    SYMFONY__ENV__MAILER_USER=~ \
-    SYMFONY__ENV__MAILER_PASSWORD=~ \
-    SYMFONY__ENV__FROM_EMAIL=wallabag@example.com
+LABEL maintainer "Marvin Steadfast <marvin@xsteadfastx.org>"
 
+ARG WALLABAG_VERSION=2.5.2
 
-RUN echo "@testing http://dl-4.alpinelinux.org/alpine/edge/testing" >> /etc/apk/repositories \
- && apk add --update \
+RUN apk add gnu-libiconv --update-cache --repository http://dl-cdn.alpinelinux.org/alpine/edge/community/ --allow-untrusted
+ENV LD_PRELOAD /usr/lib/preloadable_libiconv.so php
+
+RUN set -ex \
+ && apk update \
+ && apk upgrade --available \
+ && apk add \
       ansible \
       curl \
       git \
-      libwebp@testing \
+      libwebp \
       mariadb-client \
       nginx \
       pcre \
       php7 \
-      php7-ctype@testing \
-      php7-curl@testing \
-      php7-dom@testing \
-      php7-fpm@testing \
-      php7-gd@testing \
-      php7-gettext@testing \
-      php7-iconv@testing \
-      php7-json@testing \
-      php7-mbstring@testing \
-      php7-openssl@testing \
-      php7-pdo_mysql@testing \
-      php7-pdo_pgsql@testing \
-      php7-pdo_sqlite@testing \
-      php7-phar@testing \
-      php7-session@testing \
-      php7-xml@testing \
-      php7@testing\
-      py-mysqldb \
-      py-psycopg2 \
+      php7-amqp \
+      php7-bcmath \
+      php7-ctype \
+      php7-curl \
+      php7-dom \
+      php7-fpm \
+      php7-gd \
+      php7-gettext \
+      php7-iconv \
+      php7-json \
+      php7-mbstring \
+      php7-openssl \
+      php7-pdo_mysql \
+      php7-pdo_pgsql \
+      php7-pdo_sqlite \
+      php7-phar \
+      php7-session \
+      php7-simplexml \
+      php7-tokenizer \
+      php7-xml \
+      php7-zlib \
+      php7-sockets \
+      php7-xmlreader \
+      php7-tidy \
+      php7-intl \
+      py3-mysqlclient \
+      py3-psycopg2 \
       py-simplejson \
+      rabbitmq-c \
       s6 \
- && rm -rf /var/cache/apk/*
-
-RUN ln -s /usr/bin/php7 /usr/bin/php \
+      tar \
+      tzdata \
+      make \
+      bash \
+ && rm -rf /var/cache/apk/* \
  && ln -sf /dev/stdout /var/log/nginx/access.log \
- && ln -sf /dev/stderr /var/log/nginx/error.log
-
-RUN curl -s http://getcomposer.org/installer | php \
- && mv composer.phar /usr/local/bin/composer
-
-RUN git clone --branch $WALLABAG_VERSION --depth 1 https://github.com/wallabag/wallabag.git /var/www/wallabag
+ && ln -sf /dev/stderr /var/log/nginx/error.log \
+ && curl -s https://getcomposer.org/installer | php \
+ && mv composer.phar /usr/local/bin/composer \
+ && composer selfupdate 2.2.12 \
+ && git clone --branch $WALLABAG_VERSION --depth 1 https://github.com/wallabag/wallabag.git /var/www/wallabag
 
 COPY root /
 
-RUN cd /var/www/wallabag \
- && SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist
-
-RUN chown -R nobody:nobody /var/www/wallabag
-
-RUN chmod +x /entrypoint.sh
+RUN set -ex \
+ && cd /var/www/wallabag \
+ && SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist --no-progress \
+ && chown -R nobody:nobody /var/www/wallabag
 
 EXPOSE 80
 ENTRYPOINT ["/entrypoint.sh"]

README.md

@@ -1,5 +1,9 @@
 # What is wallabag?
 
+![CI](https://github.com/wallabag/docker/workflows/CI/badge.svg)
+[![Docker Stars](https://img.shields.io/docker/stars/wallabag/wallabag.svg?maxAge=2592000)](https://hub.docker.com/r/wallabag/wallabag/)
+[![Docker Pulls](https://img.shields.io/docker/pulls/wallabag/wallabag.svg?maxAge=2592000)](https://hub.docker.com/r/wallabag/wallabag/)
+
 [wallabag](https://www.wallabag.org/) is a self hostable application for saving web pages. Unlike other services, wallabag is free (as in freedom) and open source.
 
 With this application you will not miss content anymore. Click, save, read it when you want. It saves the content you select so that you can read it when you have time.
@@ -11,56 +15,102 @@ Default login is `wallabag:wallabag`.
 ## Environment variables
 
 - `-e MYSQL_ROOT_PASSWORD=...` (needed for the mariadb container to initialise and for the entrypoint in the wallabag container to create a database and user if its not there)
-- `-e POSTGRES_PASSWORD=...` (needed for the posgres container to initialise and for the entrypoint in the wallabag container to create a database and user if not there)
+- `-e POSTGRES_PASSWORD=...` (needed for the postgres container to initialise and for the entrypoint in the wallabag container to create a database and user if not there)
+- `-e POSTGRES_USER=...` (needed for the posgres container to initialise and for the entrypoint in the wallabag container to create a database and user if not there)
 - `-e SYMFONY__ENV__DATABASE_DRIVER=...` (defaults to "pdo_sqlite", this sets the database driver to use)
 - `-e SYMFONY__ENV__DATABASE_HOST=...` (defaults to "127.0.0.1", if use mysql this should be the name of the mariadb container)
 - `-e SYMFONY__ENV__DATABASE_PORT=...` (port of the database host)
 - `-e SYMFONY__ENV__DATABASE_NAME=...`(defaults to "symfony", this is the name of the database to use)
 - `-e SYMFONY__ENV__DATABASE_USER=...` (defaults to "root", this is the name of the database user to use)
 - `-e SYMFONY__ENV__DATABASE_PASSWORD=...` (defaults to "~", this is the password of the database user to use)
+- `-e SYMFONY__ENV__DATABASE_CHARSET=...` (defaults to utf8, this is the database charset to use)
 - `-e SYMFONY__ENV__SECRET=...` (defaults to "ovmpmAWXRCabNlMgzlzFXDYmCFfzGv")
-- `-e SYMFONY__ENV__MAILER_HOST=...`  defaults to "127.0.0.1", the SMTP host)
+- `-e SYMFONY__ENV__LOCALE=...` (default to en)
+- `-e SYMFONY__ENV__MAILER_HOST=...`  (defaults to "127.0.0.1", the SMTP host)
 - `-e SYMFONY__ENV__MAILER_USER=...` (defaults to "~", the SMTP user)
 - `-e SYMFONY__ENV__MAILER_PASSWORD=...`(defaults to "~", the SMTP password)
-- `-e SYMFONY__ENV__FROM_EMAIL=...`(defaults to "wallabag@example.com", the address wallabag uses for outgoing emails)
-## sqlite
+- `-e SYMFONY__ENV__FROM_EMAIL=...`(defaults to "`wallabag@example.com`", the address wallabag uses for outgoing emails)
+- `-e SYMFONY__ENV__TWOFACTOR_AUTH=...` (defaults to "true", enable or disable two-factor authentication)
+- `-e SYMFONY__ENV__TWOFACTOR_SENDER=...` (defaults to "`no-reply@wallabag.org`", the address wallabag uses for two-factor emails)
+- `-e SYMFONY__ENV__FOSUSER_REGISTRATION=...`(defaults to "true", enable or disable public user registration)
+- `-e SYMFONY__ENV__FOSUSER_CONFIRMATION=...`(defaults to "true", enable or disable registration confirmation)
+- `-e SYMFONY__ENV__DOMAIN_NAME=...`  defaults to "`https://your-wallabag-url-instance.com`", the URL of your wallabag instance)
+- `-e SYMFONY__ENV__REDIS_SCHEME=...` (defaults to "tcp", protocol to use to communicate with the target server (tcp, unix, or http))
+- `-e SYMFONY__ENV__REDIS_HOST=...` (defaults to "redis", IP or hostname of the target server)
+- `-e SYMFONY__ENV__REDIS_PORT=...` (defaults to "6379", port of the target host)
+- `-e SYMFONY__ENV__REDIS_PATH=...`(defaults to "~", path of the unix socket file)
+- `-e SYMFONY__ENV__REDIS_PASSWORD=...` (defaults to "~", this is the password defined in the Redis server configuration)
+- `-e SYMFONY__ENV__SENTRY_DSN=...` (defaults to "~", this is the data source name for sentry)
+- `-e POPULATE_DATABASE=...`(defaults to "True". Does the DB has to be populated or is it an existing one)
+- `-e SYMFONY__ENV__SERVER_NAME=...` (defaults to "Your wallabag instance". Specifies a user-friendly name for the 2FA issuer)
 
-The easiest way to start wallabag is to use the sqlite backend. You can spin that up with
+## SQLite
+
+The easiest way to start wallabag is to use the SQLite backend. You can spin that up with
 
 ```
-$ docker run -p 80:80 xsteadfastx/wallabag
+$ docker run -p 80:80 -e "SYMFONY__ENV__DOMAIN_NAME=http://localhost" wallabag/wallabag
 ```
 
-and point your browser to `http://localhost:80`. For persistent storage you should start the container with the a volume:
+and point your browser to `http://localhost`. For persistent storage you should start the container with a volume:
 
 ```
-$ docker run -v /opt/wallabag:/var/www/wallabag/data -p 80:80 xsteadfastx/wallabag
+$ docker run -v /opt/wallabag/data:/var/www/wallabag/data -v /opt/wallabag/images:/var/www/wallabag/web/assets/images -p 80:80 -e "SYMFONY__ENV__DOMAIN_NAME=http://localhost" wallabag/wallabag
 ```
 
-## mariadb / mysql
+## MariaDB / MySQL
 
-For using mariadb or mysql you have to define some environment variables with the container. Example:
+For using MariaDB or MySQL you have to define some environment variables with the container. Example:
 
 ```
-$ docker run docker run --name wallabag-db -e "MYSQL_ROOT_PASSWORD=my-secret-pw" -d mariadb
-$ docker run --name wallabag --link wallabag-db:wallabag-db -e "MYSQL_ROOT_PASSWORD=my-secret-pw" -e "SYMFONY__ENV__DATABASE_DRIVER=pdo_mysql" -e "SYMFONY__ENV__DATABASE_HOST=wallabag-db" -e "SYMFONY__ENV__DATABASE_PORT=3306" -e "SYMFONY__ENV__DATABASE_NAME=wallabag" -e "SYMFONY__ENV__DATABASE_USER=wallabag" -e "SYMFONY__ENV__DATABASE_PASSWORD=wallapass" -p 80:80 wallabag/wallabag
+$ docker run --name wallabag-db -e "MYSQL_ROOT_PASSWORD=my-secret-pw" -d mariadb
+$ docker run --name wallabag --link wallabag-db:wallabag-db -e "MYSQL_ROOT_PASSWORD=my-secret-pw" -e "SYMFONY__ENV__DATABASE_DRIVER=pdo_mysql" -e "SYMFONY__ENV__DATABASE_HOST=wallabag-db" -e "SYMFONY__ENV__DATABASE_PORT=3306" -e "SYMFONY__ENV__DATABASE_NAME=wallabag" -e "SYMFONY__ENV__DATABASE_USER=wallabag" -e "SYMFONY__ENV__DATABASE_PASSWORD=wallapass" -e "SYMFONY__ENV__DATABASE_CHARSET=utf8mb4" -e "SYMFONY__ENV__DOMAIN_NAME=http://localhost" -p 80:80 wallabag/wallabag
 ```
 
-## postgresql
+## PostgreSQL
 
-For using postgresql you have to define some environment variables with the container. Example:
+For using PostgreSQL you have to define some environment variables with the container. Example:
 
 ```
-$ docker run docker run --name wallabag-db -e "POSTGRES_PASSWORD=my-secret-pw" -d postgres
-$ docker run --name wallabag --link wallabag-db:wallabag-db -e "POSTGRES_PASSWORD=my-secret-pw" -e "SYMFONY__ENV__DATABASE_DRIVER=pdo_pgsql" -e "SYMFONY__ENV__DATABASE_HOST=wallabag-db" -e "SYMFONY__ENV__DATABASE_PORT=5432" -e "SYMFONY__ENV__DATABASE_NAME=wallabag" -e "SYMFONY__ENV__DATABASE_USER=wallabag" -e "SYMFONY__ENV__DATABASE_PASSWORD=wallapass" -p 80:80 wallabag/wallabag
+$ docker run --name wallabag-db -e "POSTGRES_PASSWORD=my-secret-pw" -e "POSTGRES_USER=my-super-user" -d postgres:9.6
+$ docker run --name wallabag --link wallabag-db:wallabag-db -e "POSTGRES_PASSWORD=my-secret-pw" -e "POSTGRES_USER=my-super-user" -e "SYMFONY__ENV__DATABASE_DRIVER=pdo_pgsql" -e "SYMFONY__ENV__DATABASE_HOST=wallabag-db" -e "SYMFONY__ENV__DATABASE_PORT=5432" -e "SYMFONY__ENV__DATABASE_NAME=wallabag" -e "SYMFONY__ENV__DATABASE_USER=wallabag" -e "SYMFONY__ENV__DATABASE_PASSWORD=wallapass" -e "SYMFONY__ENV__DOMAIN_NAME=http://localhost" -p 80:80 wallabag/wallabag
+```
+
+## Redis
+
+To use redis with a Docker link, a redis container with the name `redis` is needed and none of the `REDIS` environmental variables are needed:
+
+ ```
+$ docker run -p 6379:6379 --name redis redis:alpine
+$ docker run -p 80:80 -e "SYMFONY__ENV__DOMAIN_NAME=http://localhost" --link redis:redis wallabag/wallabag
+```
+
+To use redis with an external redis host, set the appropriate environmental variables. Example:
+
+```
+$ docker run -p 80:80 -e "SYMFONY__ENV__REDIS_HOST=my.server.hostname" -e "SYMFONY__ENV__REDIS_PASSWORD=my-secret-pw" -e "SYMFONY__ENV__DOMAIN_NAME=http://localhost" wallabag/wallabag
+```
+
+## Upgrading
+
+If there is a version upgrade that needs a database migration. The most easy way to do is running the `migrate` command:
+
+```
+$ docker run --link wallabag-db:wallabag-db -e <... your config variables here ...>  wallabag/wallabag migrate
+```
+
+Or you can start the container with the new image and run the migration command manually:
+
+```
+$ docker exec -t NAME_OR_ID_OF_YOUR_WALLABAG_CONTAINER /var/www/wallabag/bin/console doctrine:migrations:migrate --env=prod --no-interaction
 ```
 
 ## docker-compose
 
-It's a good way to use [docker-compose](https://docs.docker.com/compose/). Example:
+An example [docker-compose](https://docs.docker.com/compose/) file can be seen below:
 
 ```
-version: '2'
+version: '3'
 services:
   wallabag:
     image: wallabag/wallabag
@@ -72,19 +122,42 @@ services:
       - SYMFONY__ENV__DATABASE_NAME=wallabag
       - SYMFONY__ENV__DATABASE_USER=wallabag
       - SYMFONY__ENV__DATABASE_PASSWORD=wallapass
+      - SYMFONY__ENV__DATABASE_CHARSET=utf8mb4
       - SYMFONY__ENV__MAILER_HOST=127.0.0.1
       - SYMFONY__ENV__MAILER_USER=~
       - SYMFONY__ENV__MAILER_PASSWORD=~
       - SYMFONY__ENV__FROM_EMAIL=wallabag@example.com
+      - SYMFONY__ENV__DOMAIN_NAME=https://your-wallabag-url-instance.com
+      - SYMFONY__ENV__SERVER_NAME="Your wallabag instance"
     ports:
       - "80"
+    volumes:
+      - /opt/wallabag/images:/var/www/wallabag/web/assets/images
+    healthcheck:
+      test: ["CMD", "wget" ,"--no-verbose", "--tries=1", "--spider", "http://localhost"]
+      interval: 1m
+      timeout: 3s
+    depends_on:
+      - db
+      - redis
   db:
     image: mariadb
     environment:
       - MYSQL_ROOT_PASSWORD=wallaroot
     volumes:
-      - /opt/wallabag:/var/lib/mysql
+      - /opt/wallabag/data:/var/lib/mysql
+    healthcheck:
+      test: ["CMD", "mysqladmin" ,"ping", "-h", "localhost"]
+      interval: 20s
+      timeout: 3s
+  redis:
+    image: redis:alpine
+    healthcheck:
+      test: ["CMD", "redis-cli", "ping"]
+      interval: 20s
+      timeout: 3s
 ```
+
 Note that you must fill out the mail related variables according to your mail config.
 
 ## nginx
@@ -109,3 +182,11 @@ server {
 
 }
 ```
+
+## Import worker
+
+To run the [async redis import worker](https://doc.wallabag.org/en/admin/asynchronous.html#install-redis-for-asynchronous-tasks) use the following command:
+```
+$ docker run --name wallabag --link wallabag-db:wallabag-db --link redis:redis -e <... your config variables here ...>  wallabag/wallabag import <type>
+```
+Where `<type>` is one of pocket, readability, instapaper, wallabag_v1, wallabag_v2, firefox or chrome.

root/entrypoint.sh

@@ -1,8 +1,28 @@
 #!/bin/sh
 
+provisioner () {
+    echo "Starting provisioner..."
+    if ! out=`ansible-playbook -i /etc/ansible/hosts /etc/ansible/entrypoint.yml -c local "$@"`;then
+        echo $out;
+    fi
+    echo "Provisioner finished."
+}
+
 if [ "$1" = "wallabag" ];then
-    ansible-playbook -i /etc/ansible/hosts /etc/ansible/entrypoint.yml -c local
+    provisioner
     exec s6-svscan /etc/s6/
 fi
 
+if [ "$1" = "import" ];then
+    provisioner --skip-tags=firstrun
+    cd /var/www/wallabag/
+    exec su -c "bin/console wallabag:import:redis-worker --env=prod $2 -vv" -s /bin/sh nobody
+fi
+
+if [ "$1" = "migrate" ];then
+    provisioner
+    cd /var/www/wallabag/
+    exec su -c "bin/console doctrine:migrations:migrate --env=prod --no-interaction" -s /bin/sh nobody
+fi
+
 exec "$@"

root/etc/ansible/entrypoint.yml

@@ -4,14 +4,39 @@
 
   vars:
 
-    database_driver: "{{ lookup('env', 'SYMFONY__ENV__DATABASE_DRIVER') }}"
-    database_host: "{{ lookup('env', 'SYMFONY__ENV__DATABASE_HOST') }}"
-    database_name: "{{ lookup('env', 'SYMFONY__ENV__DATABASE_NAME') }}"
-    database_password: "{{ lookup('env', 'SYMFONY__ENV__DATABASE_PASSWORD') }}"
-    database_port: "{{ lookup('env', 'SYMFONY__ENV__DATABASE_PORT') }}"
+    database_driver: "{{ lookup('env', 'SYMFONY__ENV__DATABASE_DRIVER')|default('pdo_sqlite', true) }}"
+    database_host: "{{ lookup('env', 'SYMFONY__ENV__DATABASE_HOST')|default('127.0.0.1', true) }}"
+    database_name: "{{ lookup('env', 'SYMFONY__ENV__DATABASE_NAME')|default('symfony', true) }}"
+    database_password: "{{ lookup('env', 'SYMFONY__ENV__DATABASE_PASSWORD')|default('~', true) }}"
+    database_port: "{{ lookup('env', 'SYMFONY__ENV__DATABASE_PORT')|default('~', true) }}"
     database_root_password_mariadb: "{{ lookup('env', 'MYSQL_ROOT_PASSWORD') }}"
+    database_root_user_postgres: "{{ lookup('env', 'POSTGRES_USER') }}"
     database_root_password_postgres: "{{ lookup('env', 'POSTGRES_PASSWORD') }}"
-    database_user: "{{ lookup('env', 'SYMFONY__ENV__DATABASE_USER') }}"
+    database_user: "{{ lookup('env', 'SYMFONY__ENV__DATABASE_USER')|default('root', true) }}"
+    database_charset: "{{ lookup('env', 'SYMFONY__ENV__DATABASE_CHARSET')|default('utf8', true) }}"
+    populate_database: "{{ lookup('env', 'POPULATE_DATABASE')|default(True, true) }}"
+    locale: "{{ lookup('env', 'SYMFONY__ENV__LOCALE')|default('en', true) }}"
+    secret: "{{ lookup('env', 'SYMFONY__ENV__SECRET')|default('ovmpmAWXRCabNlMgzlzFXDYmCFfzGv', true) }}"
+    mailer_transport: "{{ lookup('env', 'SYMFONY__ENV__MAILER_TRANSPORT')|default('smtp', true) }}"
+    mailer_host: "{{ lookup('env', 'SYMFONY__ENV__MAILER_HOST')|default('127.0.0.1', true) }}"
+    mailer_user: "{{ lookup('env', 'SYMFONY__ENV__MAILER_USER')|default('~', true) }}"
+    mailer_password: "{{ lookup('env', 'SYMFONY__ENV__MAILER_PASSWORD')|default('~', true) }}"
+    mailer_port: "{{ lookup('env', 'SYMFONY__ENV__MAILER_PORT')|default('25', true) }}"
+    mailer_encryption: "{{ lookup('env', 'SYMFONY__ENV__MAILER_ENCRYPTION')|default('~', true) }}"
+    mailer_auth_mode: "{{ lookup('env', 'SYMFONY__ENV__MAILER_AUTH_MODE')|default('~', true) }}"
+    from_email: "{{ lookup('env', 'SYMFONY__ENV__FROM_EMAIL')|default('wallabag@example.com', true) }}"
+    twofactor_auth: "{{ lookup('env', 'SYMFONY__ENV__TWOFACTOR_AUTH')|default('true', true) }}"
+    twofactor_sender: "{{ lookup('env', 'SYMFONY__ENV__TWOFACTOR_SENDER')|default('no-reply@wallabag.org', true) }}"
+    registration: "{{ lookup('env', 'SYMFONY__ENV__FOSUSER_REGISTRATION')|default('true', true) }}"
+    registration_mail_confirmation: "{{ lookup('env', 'SYMFONY__ENV__FOSUSER_CONFIRMATION')|default('true', true) }}"
+    domain_name: "{{ lookup('env', 'SYMFONY__ENV__DOMAIN_NAME')|default('https://your-wallabag-url-instance.com', true) }}"
+    redis_scheme: "{{ lookup('env', 'SYMFONY__ENV__REDIS_SCHEME')|default('tcp', true) }}"
+    redis_host: "{{ lookup('env', 'SYMFONY__ENV__REDIS_HOST')|default('redis', true) }}"
+    redis_port: "{{ lookup('env', 'SYMFONY__ENV__REDIS_PORT')|default('6379', true) }}"
+    redis_path: "{{ lookup('env', 'SYMFONY__ENV__REDIS_PATH')|default('~', true) }}"
+    redis_password: "{{ lookup('env', 'SYMFONY__ENV__REDIS_PASSWORD')|default('~', true) }}"
+    sentry_dsn: "{{ lookup('env', 'SYMFONY__ENV__SENTRY_DSN')|default('~', true) }}"
+    server_name: "{{ lookup('env', 'SYMFONY__ENV__SERVER_NAME')|default('Your wallabag instance', true) }}"
 
   tasks:
 
@@ -20,9 +45,19 @@
         path={{ item }}
         state=directory
       with_items:
-        - /var/www/wallabag/data/db
+        - /var/www/wallabag/app
+        - /var/www/wallabag/app/config
+        - /var/www/wallabag/data
         - /var/www/wallabag/data/assets
+        - /var/www/wallabag/data/db
       notify: chown dir
+      tags:
+        - firstrun
+
+    - name: write parameters.yml
+      template:
+        src=templates/parameters.yml.j2
+        dest=/var/www/wallabag/app/config/parameters.yml
 
     - stat:
         path=/var/www/wallabag/data/db/wallabag.sqlite
@@ -52,8 +87,12 @@
         login_port={{ database_port }}
         login_user=root
         login_password="{{ database_root_password_mariadb }}"
+        encoding="utf8mb4"
       notify: run install
-      when: database_driver == 'pdo_mysql'
+      when: (database_driver == 'pdo_mysql') and
+            (populate_database == True)
+      tags:
+        - firstrun
 
     - name: add mariadb user
       mysql_user:
@@ -67,7 +106,10 @@
         login_password="{{ database_root_password_mariadb }}"
         state=present
       when: (database_driver == 'pdo_mysql') and
-            (database_user != 'root')
+            (database_user != 'root') and
+            (populate_database == True)
+      tags:
+        - firstrun
 
     - name: postgresql db
       postgresql_db:
@@ -75,24 +117,31 @@
         state=present
         login_host="{{ database_host }}"
         port={{ database_port }}
-        login_user=postgres
+        login_user="{{ database_root_user_postgres }}"
         login_password="{{ database_root_password_postgres }}"
       notify: run install
-      when: database_driver == 'pdo_pgsql'
+      when: (database_driver == 'pdo_pgsql') and
+            (populate_database == True)
+      tags:
+        - firstrun
 
     - name: add postgresql user
       postgresql_user:
         name="{{ database_user }}"
         password="{{ database_password }}"
+        encrypted=true
         db={{ database_name }}
         priv=ALL
         login_host="{{ database_host }}"
         port={{ database_port }}
-        login_user=postgres
+        login_user="{{ database_root_user_postgres }}"
         login_password="{{ database_root_password_postgres }}"
         state=present
       when: (database_driver == 'pdo_pgsql') and
-            (database_user != 'postgres')
+            (database_user != 'postgres') and
+            (populate_database == True)
+      tags:
+        - firstrun
 
     - name: remove cache
       file:

root/etc/ansible/templates/parameters.yml.j2

@@ -0,0 +1,63 @@
+parameters:
+    database_driver: {{ database_driver }}
+    database_host: {{ database_host }}
+    database_port: {{ database_port }}
+    database_name: {{ database_name }}
+    database_user: {{ database_user }}
+    database_password: {{ database_password }}
+    database_path: "%kernel.root_dir%/../data/db/wallabag.sqlite"
+    database_table_prefix: wallabag_
+    database_socket: null
+    database_charset: {{ database_charset }}
+
+    domain_name: {{ domain_name }}
+
+    mailer_transport:  {{ mailer_transport }}
+    mailer_user:       {{ mailer_user }}
+    mailer_password:   {{ mailer_password }}
+    mailer_host:       {{ mailer_host }}
+    mailer_port:       {{ mailer_port }}
+    mailer_encryption: {{ mailer_encryption }}
+    mailer_auth_mode:  {{ mailer_auth_mode }}
+
+    locale:            {{ locale }}
+
+    # A secret key that's used to generate certain security-related tokens
+    secret: {{ secret }}
+
+    # two factor stuff
+    twofactor_auth: {{ twofactor_auth }}
+    twofactor_sender: {{ twofactor_sender }}
+
+    # fosuser stuff
+    fosuser_registration: {{ registration }}
+    fosuser_confirmation: {{ registration_mail_confirmation }}
+
+    # how long the access token should live in seconds for the API
+    fos_oauth_server_access_token_lifetime: 3600
+    # how long the refresh token should life in seconds for the API
+    fos_oauth_server_refresh_token_lifetime: 1209600
+
+    from_email: {{ from_email }}
+
+    rss_limit: 50
+
+    # RabbitMQ processing
+    rabbitmq_host: localhost
+    rabbitmq_port: 5672
+    rabbitmq_user: guest
+    rabbitmq_password: guest
+    rabbitmq_prefetch_count: 10
+
+    # Redis processing
+    redis_scheme: {{ redis_scheme }}
+    redis_host: {{ redis_host }}
+    redis_port: {{ redis_port }}
+    redis_path: {{ redis_path }}
+    redis_password: {{ redis_password }}
+
+    # sentry logging
+    sentry_dsn: {{ sentry_dsn }}
+
+    # User-friendly name of your instance for 2FA issuer
+    server_name: {{ server_name }}

root/etc/nginx/nginx.conf

@@ -23,7 +23,7 @@ http {
     gzip on;
     gzip_disable "msie6";
     open_file_cache max=100;
-    client_max_body_size 50M;
+    client_max_body_size 100M;
 
 
     upstream php-upstream {
@@ -31,6 +31,7 @@ http {
     }
 
     server {
+        listen 80;
         server_name _;
         root /var/www/wallabag/web;
 

root/etc/php7/php.ini

@@ -268,7 +268,7 @@ output_buffering = 4096
 ; Note: You need to use zlib.output_handler instead of the standard
 ;   output_handler, or otherwise the output will be corrupted.
 ; http://php.net/zlib.output-compression
-zlib.output_compression = Off
+zlib.output_compression = On
 
 ; http://php.net/zlib.output-compression-level
 ;zlib.output_compression_level = -1
@@ -373,7 +373,7 @@ zend.enable_gc = On
 ; threat in any way, but it makes it possible to determine whether you use PHP
 ; on your server or not.
 ; http://php.net/expose-php
-expose_php = On
+expose_php = Off
 
 ;;;;;;;;;;;;;;;;;;;
 ; Resource Limits ;
@@ -670,7 +670,7 @@ auto_globals_jit = On
 ; Its value may be 0 to disable the limit. It is ignored if POST data reading
 ; is disabled through enable_post_data_reading.
 ; http://php.net/post-max-size
-post_max_size = 20G
+post_max_size = 100M
 
 ; Automatically add files before PHP document.
 ; http://php.net/auto-prepend-file
@@ -802,7 +802,7 @@ upload_tmp_dir = /tmp/
 
 ; Maximum allowed size for uploaded files.
 ; http://php.net/upload-max-filesize
-upload_max_filesize = 20G
+upload_max_filesize = 100M
 
 ; Maximum number of files that can be uploaded via a single request
 max_file_uploads = 20

root/etc/s6/.s6-svscan/finish

@@ -0,0 +1,2 @@
+#!/bin/sh
+exec /bin/true

root/var/www/wallabag/app/config/parameters.yml

@@ -1,36 +1,63 @@
 parameters:
-    database_driver: %env.database_driver%
-    database_host: %env.database_host%
-    database_port: %env.database_port%
-    database_name: %env.database_name%
-    database_user: %env.database_user%
-    database_password: %env.database_password%
+    database_driver: pdo_sqlite
+    database_host: 127.0.0.1
+    database_port: ~
+    database_name: symfony
+    database_user: root
+    database_password: ~
     database_path: "%kernel.root_dir%/../data/db/wallabag.sqlite"
     database_table_prefix: wallabag_
+    database_socket: null
+    database_charset: utf8
 
-    test_database_driver: pdo_sqlite
-    test_database_host: 127.0.0.1
-    test_database_port: ~
-    test_database_name: ~
-    test_database_user: ~
-    test_database_password: ~
-    test_database_path: "%kernel.root_dir%/../data/db/wallabag_test.sqlite"
+    domain_name: https://your-wallabag-url-instance.com
 
     mailer_transport:  smtp
-    mailer_host:       %env.mailer_host%
-    mailer_user:       %env.mailer_user%
-    mailer_password:   %env.mailer_password%
+    mailer_user:       ~
+    mailer_password:   ~
+    mailer_host:       127.0.0.1
+    mailer_port:       false
+    mailer_encryption: ~
+    mailer_auth_mode:  ~
 
     locale:            en
 
     # A secret key that's used to generate certain security-related tokens
-    secret:            %env.secret%
+    secret: ovmpmAWXRCabNlMgzlzFXDYmCFfzGv
 
     # two factor stuff
     twofactor_auth: true
-    twofactor_sender: %env.from_email%
+    twofactor_sender: no-reply@wallabag.org
 
     # fosuser stuff
+    fosuser_registration: true
     fosuser_confirmation: true
 
-    from_email: %env.from_email%
+    # how long the access token should live in seconds for the API
+    fos_oauth_server_access_token_lifetime: 3600
+    # how long the refresh token should life in seconds for the API
+    fos_oauth_server_refresh_token_lifetime: 1209600
+
+    from_email: no-reply@wallabag.org
+
+    rss_limit: 50
+
+    # RabbitMQ processing
+    rabbitmq_host: localhost
+    rabbitmq_port: 5672
+    rabbitmq_user: guest
+    rabbitmq_password: guest
+    rabbitmq_prefetch_count: 10
+
+    # Redis processing
+    redis_scheme: tcp
+    redis_host: localhost
+    redis_port: 6379
+    redis_path: null
+    redis_password: null
+
+    # sentry logging
+    sentry_dsn: ~
+
+    # User-friendly name of your instance for 2FA issuer
+    server_name: Your wallabag instance

tests/docker-compose.default.yml

@@ -0,0 +1,9 @@
+version: '2'
+services:
+  wallabag:
+    build:
+      context: ../
+    image: wallabag:default
+    container_name: wallabag
+    ports:
+      - "127.0.0.1:80:80"

tests/docker-compose.mariadb.yml

@@ -0,0 +1,23 @@
+version: '2'
+services:
+  wallabag:
+    build:
+      context: ../
+    image: wallabag:mariadb
+    container_name: wallabag
+    environment:
+      - MYSQL_ROOT_PASSWORD=wallaroot
+      - SYMFONY__ENV__SECRET=F00B4R
+      - SYMFONY__ENV__DATABASE_DRIVER=pdo_mysql
+      - SYMFONY__ENV__DATABASE_HOST=db
+      - SYMFONY__ENV__DATABASE_PORT=3306
+      - SYMFONY__ENV__DATABASE_NAME=wallabag
+      - SYMFONY__ENV__DATABASE_USER=wallabag
+      - SYMFONY__ENV__DATABASE_PASSWORD=wallapass
+    ports:
+      - "127.0.0.1:80:80"
+  db:
+    image: mariadb
+    command: mysqld --character-set-server=utf8mb4 --collation-server=utf8mb4_unicode_ci --character-set-client-handshake=FALSE
+    environment:
+      - MYSQL_ROOT_PASSWORD=wallaroot

tests/docker-compose.postgresql.yml

@@ -0,0 +1,24 @@
+version: '2'
+services:
+  wallabag:
+    build:
+      context: ../
+    image: wallabag:postgresql
+    container_name: wallabag
+    environment:
+      - POSTGRES_PASSWORD=my-secret-pw
+      - POSTGRES_USER=my-super-user
+      - SYMFONY__ENV__SECRET=F00B4R
+      - SYMFONY__ENV__DATABASE_DRIVER=pdo_pgsql
+      - SYMFONY__ENV__DATABASE_HOST=db
+      - SYMFONY__ENV__DATABASE_PORT=5432
+      - SYMFONY__ENV__DATABASE_NAME=wallabag
+      - SYMFONY__ENV__DATABASE_USER=wallabag
+      - SYMFONY__ENV__DATABASE_PASSWORD=wallapass
+    ports:
+      - "127.0.0.1:80:80"
+  db:
+    image: postgres:10.3
+    environment:
+      - POSTGRES_PASSWORD=my-secret-pw
+      - POSTGRES_USER=my-super-user

tests/docker-compose.sqlite.yml

@@ -0,0 +1,17 @@
+version: '2'
+services:
+  wallabag:
+    build:
+      context: ../
+    image: wallabag:sqlite
+    container_name: wallabag
+    environment:
+      - SYMFONY__ENV__DATABASE_DRIVER=pdo_sqlite
+      - SYMFONY__ENV__DATABASE_HOST=127.0.0.1
+      - SYMFONY__ENV__DATABASE_PORT=~
+      - SYMFONY__ENV__DATABASE_NAME=symfony
+      - SYMFONY__ENV__DATABASE_USER=root
+      - SYMFONY__ENV_DATABASE_PASSWORD=~
+      - SYMFONY__ENV__SECRET=F00B4R
+    ports:
+      - "127.0.0.1:80:80"

tests/test_login.py

@@ -0,0 +1,47 @@
+import pytest
+import re
+import requests
+
+
+URL = 'http://127.0.0.1:80'
+
+
+def test_accessing_login_page():
+    r = requests.get(URL, allow_redirects=True)
+
+    assert r.status_code == 200
+    assert 'Log in' in r.text
+    assert 'Password' in r.text
+    assert 'Register' in r.text
+    assert 'Username' in r.text
+
+
+def test_logging_in():
+    client = requests.session()
+    r = client.get(URL, allow_redirects=True)
+    jar = r.cookies
+
+    # get csrf token
+    csrf_match = re.search(
+        '<input type="hidden" name="_csrf_token" value="(.*)" />',
+        r.text
+    )
+
+    if csrf_match:
+        csrf = csrf_match.group(1)
+    else:
+        # if there is no csrf token the test will fail
+        pytest.fail('csrf not matched')
+
+    data = {
+        '_username': 'wallabag',
+        '_password': 'wallabag',
+        '_csrf_token': csrf
+    }
+
+    r = client.post(URL + '/login_check', cookies=jar, data=data)
+    assert r.status_code == 200
+    assert '/unread/list' in r.text
+    assert '/starred/list' in r.text
+    assert '/archive/list' in r.text
+    assert '/all/list' in r.text