Merge pull request #225 from wallabag/release-2.4.0

2.4.0

.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/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/

.travis.yml

@@ -1,26 +0,0 @@
-language: python
-
-python:
-  - 3.5
-
-services:
-  - docker
-
-env:
-  - DB_TYPE=default
-  - DB_TYPE=sqlite
-  - DB_TYPE=mariadb
-  - DB_TYPE=postgresql
-
-install:
-  - docker-compose -f tests/docker-compose.$DB_TYPE.yml build
-  - docker-compose -f tests/docker-compose.$DB_TYPE.yml up -d
-
-before_script:
-  - pip install pytest
-  - pip install requests
-
-script:
-  - docker ps | grep -q wallabag
-  - sleep 60
-  - py.test tests/

Dockerfile

@@ -1,8 +1,11 @@
-FROM alpine:edge
+FROM alpine:3.12
 
 LABEL maintainer "Marvin Steadfast <marvin@xsteadfastx.org>"
 
-ARG WALLABAG_VERSION=2.3.1
+ARG WALLABAG_VERSION=2.4.0
+
+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 \
@@ -37,24 +40,30 @@ RUN set -ex \
       php7-tokenizer \
       php7-xml \
       php7-zlib \
-      py-mysqldb \
-      py-psycopg2 \
+      php7-sockets \
+      php7-xmlreader \
+      php7-tidy \
+      php7-intl \
+      py3-mysqlclient \
+      py3-psycopg2 \
       py-simplejson \
       rabbitmq-c \
       s6 \
       tar \
+      tzdata \
  && rm -rf /var/cache/apk/* \
  && ln -sf /dev/stdout /var/log/nginx/access.log \
  && 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 --1 \
  && git clone --branch $WALLABAG_VERSION --depth 1 https://github.com/wallabag/wallabag.git /var/www/wallabag
 
 COPY root /
 
 RUN set -ex \
  && cd /var/www/wallabag \
- && SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist \
+ && SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist --no-progress \
  && chown -R nobody:nobody /var/www/wallabag
 
 EXPOSE 80

README.md

@@ -1,6 +1,6 @@
 # What is wallabag?
 
-[![Build Status](https://travis-ci.org/wallabag/docker.svg?branch=master)](https://travis-ci.org/wallabag/docker)
+![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/)
 
@@ -15,7 +15,7 @@ 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)
@@ -23,14 +23,24 @@ Default login is `wallabag:wallabag`.
 - `-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)
+- `-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__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)
 
 ## SQLite
@@ -44,7 +54,7 @@ $ docker run -p 80:80 wallabag/wallabag
 and point your browser to `http://localhost:80`. For persistent storage you should start the container with a volume:
 
 ```
-$ docker run -v /opt/wallabag/data:/var/www/wallabag/data -v -/opt/wallabag/images:/var/www/wallabag/web/assets/images -p 80:80 wallabag/wallabag
+$ docker run -v /opt/wallabag/data:/var/www/wallabag/data -v /opt/wallabag/images:/var/www/wallabag/web/assets/images -p 80:80 wallabag/wallabag
 ```
 
 ## MariaDB / MySQL
@@ -53,7 +63,7 @@ For using MariaDB or MySQL you have to define some environment variables with th
 
 ```
 $ 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 --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" -p 80:80 wallabag/wallabag
 ```
 
 ## PostgreSQL
@@ -67,13 +77,19 @@ $ docker run --name wallabag --link wallabag-db:wallabag-db -e "POSTGRES_PASSWOR
 
 ## Redis
 
-To use redis support a linked redis container with the name `redis` is needed.
+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 --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" 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:
@@ -105,10 +121,12 @@ 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
     ports:
       - "80"
     volumes:
@@ -150,7 +168,7 @@ server {
 
 ## Import worker
 
-To run the [async redis import worker](http://doc.wallabag.org/en/master/developer/asynchronous.html#install-redis-for-asynchronous-tasks) use the following command:
+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>
 ```

root/etc/ansible/entrypoint.yml

@@ -17,13 +17,25 @@
     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) }}"
 
   tasks:
 
@@ -116,6 +128,7 @@
       postgresql_user:
         name="{{ database_user }}"
         password="{{ database_password }}"
+        encrypted=true
         db={{ database_name }}
         priv=ALL
         login_host="{{ database_host }}"

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

@@ -9,14 +9,16 @@ parameters:
     database_table_prefix: wallabag_
     database_socket: null
     database_charset: {{ database_charset }}
-    database_driver_class: null
 
     domain_name: {{ domain_name }}
 
-    mailer_transport:  smtp
-    mailer_host:       {{ mailer_host }}
+    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 }}
 
@@ -24,13 +26,18 @@ parameters:
     secret: {{ secret }}
 
     # two factor stuff
-    twofactor_auth: true
-    twofactor_sender: no-reply@wallabag.org
+    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
@@ -43,8 +50,11 @@ parameters:
     rabbitmq_prefetch_count: 10
 
     # Redis processing
-    redis_scheme: tcp
-    redis_host: redis
-    redis_port: 6379
-    redis_path: null
-    redis_password: null
+    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 }}

root/etc/nginx/nginx.conf

@@ -31,6 +31,7 @@ http {
     }
 
     server {
+        listen 80;
         server_name _;
         root /var/www/wallabag/web;
 

root/etc/php7/php.ini

@@ -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 ;

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

@@ -9,22 +9,16 @@ parameters:
     database_table_prefix: wallabag_
     database_socket: null
     database_charset: utf8
-    database_driver_class: null
 
     domain_name: https://your-wallabag-url-instance.com
 
-    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"
-
     mailer_transport:  smtp
-    mailer_host:       127.0.0.1
     mailer_user:       ~
     mailer_password:   ~
+    mailer_host:       127.0.0.1
+    mailer_port:       false
+    mailer_encryption: ~
+    mailer_auth_mode:  ~
 
     locale:            en
 
@@ -39,6 +33,11 @@ parameters:
     fosuser_registration: true
     fosuser_confirmation: true
 
+    # 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
@@ -56,3 +55,6 @@ parameters:
     redis_port: 6379
     redis_path: null
     redis_password: null
+
+    # sentry logging
+    sentry_dsn: ~

tests/docker-compose.mariadb.yml

@@ -18,5 +18,6 @@ services:
       - "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

@@ -18,7 +18,7 @@ services:
     ports:
       - "127.0.0.1:80:80"
   db:
-    image: postgres:9.6
+    image: postgres:10.3
     environment:
       - POSTGRES_PASSWORD=my-secret-pw
       - POSTGRES_USER=my-super-user

tests/test_login.py

@@ -10,7 +10,7 @@ def test_accessing_login_page():
     r = requests.get(URL, allow_redirects=True)
 
     assert r.status_code == 200
-    assert 'Login' in r.text
+    assert 'Log in' in r.text
     assert 'Password' in r.text
     assert 'Register' in r.text
     assert 'Username' in r.text