fixed location of php configuration to /etc/php7

Update Dockerfile for wallabag 2.1.3

.gitignore

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

.travis.yml

@@ -0,0 +1,26 @@
+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,14 +1,8 @@
 FROM alpine:edge
 MAINTAINER Marvin Steadfast <marvin@xsteadfastx.org>
 
-ENV WALLABAG_VERSION=2.0.2 \
-    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
+ENV WALLABAG_VERSION=2.1.3 \
+    POSTGRES_USER=postgres
 
 RUN echo "@testing http://dl-4.alpinelinux.org/alpine/edge/testing" >> /etc/apk/repositories \
  && apk add --update \
@@ -20,6 +14,8 @@ RUN echo "@testing http://dl-4.alpinelinux.org/alpine/edge/testing" >> /etc/apk/
       nginx \
       pcre \
       php7 \
+      php7-amqp@testing \
+      php7-bcmath \
       php7-ctype@testing \
       php7-curl@testing \
       php7-dom@testing \
@@ -31,14 +27,17 @@ RUN echo "@testing http://dl-4.alpinelinux.org/alpine/edge/testing" >> /etc/apk/
       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 \
       py-simplejson \
       s6 \
+      tar \
  && rm -rf /var/cache/apk/*
 
 RUN ln -s /usr/bin/php7 /usr/bin/php \

README.md

@@ -1,5 +1,9 @@
 # What is wallabag?
 
+[![Build Status](https://travis-ci.org/wallabag/docker.svg?branch=master)](https://travis-ci.org/wallabag/docker)
+[![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,6 +15,8 @@ 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_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)
@@ -18,28 +24,59 @@ Default login is `wallabag:wallabag`.
 - `-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__SECRET=...` (defaults to "ovmpmAWXRCabNlMgzlzFXDYmCFfzGv")
+- `-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__FOSUSER_REGISTRATION=...`(defaults to "true", enable or disable public user registration)
 
-## sqlite
+## SQLite
 
-The easiest way to start wallabag is to use the sqlite backend. You can spin that up with
+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 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:80`. 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:/var/www/wallabag/data -p 80:80 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 xsteadfastx/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" -p 80:80 wallabag/wallabag
+```
+
+## PostgreSQL
+
+For using PostgreSQL you have to define some environment variables with the container. Example:
+
+```
+$ docker run --name wallabag-db -e "POSTGRES_PASSWORD=my-secret-pw" -e "POSTGRES_USER=my-super-user" -d postgres
+$ 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" -p 80:80 wallabag/wallabag
+```
+
+## Redis
+
+To use redis support a linked redis container with the name `redis` is needed.
+
+ ```
+$ docker run -p 6379:6379 --name redis redis:alpine
+$ docker run -p 80:80 --link redis:redis wallabag/wallabag
+```
+
+## DB migration
+
+If there is a version upgrade that needs a database migration, you should start the container with the new image and run the migration command.
+
+```
+$ docker exec -t wallabag /var/www/wallabag/bin/console doctrine:migrations:migrate --env=prod --no-interaction
 ```
 
 ## docker-compose
@@ -50,8 +87,7 @@ It's a good way to use [docker-compose](https://docs.docker.com/compose/). Examp
 version: '2'
 services:
   wallabag:
-    build:
-      context: wallabag/
+    image: wallabag/wallabag
     environment:
       - MYSQL_ROOT_PASSWORD=wallaroot
       - SYMFONY__ENV__DATABASE_DRIVER=pdo_mysql
@@ -60,6 +96,10 @@ services:
       - SYMFONY__ENV__DATABASE_NAME=wallabag
       - SYMFONY__ENV__DATABASE_USER=wallabag
       - SYMFONY__ENV__DATABASE_PASSWORD=wallapass
+      - SYMFONY__ENV__MAILER_HOST=127.0.0.1
+      - SYMFONY__ENV__MAILER_USER=~
+      - SYMFONY__ENV__MAILER_PASSWORD=~
+      - SYMFONY__ENV__FROM_EMAIL=wallabag@example.com
     ports:
       - "80"
   db:
@@ -68,8 +108,12 @@ services:
       - MYSQL_ROOT_PASSWORD=wallaroot
     volumes:
       - /opt/wallabag:/var/lib/mysql
+  redis:
+    image: redis:alpine
 ```
 
+Note that you must fill out the mail related variables according to your mail config.
+
 ## nginx
 
 I use nginx to make wallabag public available. This is a example how to use it:

root/etc/ansible/entrypoint.yml

@@ -4,13 +4,21 @@
 
   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_root_password: "{{ lookup('env', 'MYSQL_ROOT_PASSWORD') }}"
-    database_user: "{{ lookup('env', 'SYMFONY__ENV__DATABASE_USER') }}"
+    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')|default('root', true) }}"
+    secret: "{{ lookup('env', 'SYMFONY__ENV__SECRET')|default('ovmpmAWXRCabNlMgzlzFXDYmCFfzGv', 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) }}"
+    from_email: "{{ lookup('env', 'SYMFONY__ENV__FROM_EMAIL')|default('wallabag@example.com', true) }}"
+    registration: "{{ lookup('env', 'SYMFONY__ENV__FOSUSER_REGISTRATION')|default('true', true) }}"
 
   tasks:
 
@@ -19,10 +27,18 @@
         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
 
+    - 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
       register: wallabag_sqlite_db
@@ -39,16 +55,18 @@
     - name: wait for db container
       wait_for:
         host="{{ database_host }}"
-        port=3306
-      when: database_driver == 'pdo_mysql'
+        port="{{ database_port }}"
+      when: (database_driver == 'pdo_mysql') or
+            (database_driver == 'pdo_pgsql')
 
-    - name: mariadb db
+    - name: add mariadb db
       mysql_db:
         name="{{ database_name }}"
         state=present
         login_host="{{ database_host }}"
+        login_port={{ database_port }}
         login_user=root
-        login_password="{{ database_root_password }}"
+        login_password="{{ database_root_password_mariadb }}"
       notify: run install
       when: database_driver == 'pdo_mysql'
 
@@ -59,13 +77,38 @@
         password="{{ database_password }}"
         priv={{ database_name }}.*:ALL
         login_host="{{ database_host }}"
-        login_port="{{ database_port }}"
+        login_port={{ database_port }}
         login_user=root
-        login_password="{{ database_root_password }}"
+        login_password="{{ database_root_password_mariadb }}"
         state=present
       when: (database_driver == 'pdo_mysql') and
             (database_user != 'root')
 
+    - name: postgresql db
+      postgresql_db:
+        name="{{ database_name }}"
+        state=present
+        login_host="{{ database_host }}"
+        port={{ database_port }}
+        login_user="{{ database_root_user_postgres }}"
+        login_password="{{ database_root_password_postgres }}"
+      notify: run install
+      when: database_driver == 'pdo_pgsql'
+
+    - name: add postgresql user
+      postgresql_user:
+        name="{{ database_user }}"
+        password="{{ database_password }}"
+        db={{ database_name }}
+        priv=ALL
+        login_host="{{ database_host }}"
+        port={{ database_port }}
+        login_user="{{ database_root_user_postgres }}"
+        login_password="{{ database_root_password_postgres }}"
+        state=present
+      when: (database_driver == 'pdo_pgsql') and
+            (database_user != 'postgres')
+
     - name: remove cache
       file:
         path=/var/www/wallabag/var/cache

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

@@ -0,0 +1,44 @@
+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
+
+    mailer_transport:  smtp
+    mailer_host:       {{ mailer_host }}
+    mailer_user:       {{ mailer_user }}
+    mailer_password:   {{ mailer_password }}
+
+    locale:            en
+
+    # A secret key that's used to generate certain security-related tokens
+    secret: {{ secret }}
+
+    # two factor stuff
+    twofactor_auth: true
+    twofactor_sender: no-reply@wallabag.org
+
+    # fosuser stuff
+    fosuser_registration: {{ registration }}
+    fosuser_confirmation: true
+
+    from_email: {{ from_email }}
+
+    rss_limit: 50
+
+    # RabbitMQ processing
+    rabbitmq_host: localhost
+    rabbitmq_port: 5672
+    rabbitmq_user: guest
+    rabbitmq_password: guest
+
+    # Redis processing
+    redis_scheme: tcp
+    redis_host: redis
+    redis_port: 6379
+    redis_path: null

root/etc/nginx/nginx.conf

@@ -23,6 +23,7 @@ http {
     gzip on;
     gzip_disable "msie6";
     open_file_cache max=100;
+    client_max_body_size 100M;
 
 
     upstream php-upstream {
@@ -57,8 +58,8 @@ http {
             internal;
         }
 
-        error_log /var/log/nginx/access.log;
-        access_log /var/log/nginx/error.log;
+        access_log /var/log/nginx/access.log;
+        error_log /var/log/nginx/error.log;
     }
 
 }

root/etc/php7/php.ini

@@ -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/var/www/wallabag/app/config/parameters.yml

@@ -1,12 +1,13 @@
 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
 
     test_database_driver: pdo_sqlite
     test_database_host: 127.0.0.1
@@ -24,13 +25,28 @@ parameters:
     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: no-reply@wallabag.org
 
     # fosuser stuff
+    fosuser_registration: true
     fosuser_confirmation: true
 
     from_email: no-reply@wallabag.org
+
+    rss_limit: 50
+
+    # RabbitMQ processing
+    rabbitmq_host: localhost
+    rabbitmq_port: 5672
+    rabbitmq_user: guest
+    rabbitmq_password: guest
+
+    # Redis processing
+    redis_scheme: tcp
+    redis_host: localhost
+    redis_port: 6379
+    redis_path: null

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,22 @@
+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
+    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
+    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 'Login' 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