Merge pull request #95 from wallabag/nicosomb-patch-1

wallabag 2.3.1

Dockerfile

@@ -1,62 +1,61 @@
 FROM alpine:edge
-MAINTAINER Marvin Steadfast <marvin@xsteadfastx.org>
 
-ENV WALLABAG_VERSION=2.1.3 \
-    POSTGRES_USER=postgres
+LABEL maintainer "Marvin Steadfast <marvin@xsteadfastx.org>"
 
-RUN echo "@testing http://dl-4.alpinelinux.org/alpine/edge/testing" >> /etc/apk/repositories \
- && apk add --update \
+ARG WALLABAG_VERSION=2.3.1
+
+RUN set -ex \
+ && apk update \
+ && apk upgrade --available \
+ && apk add \
       ansible \
       curl \
       git \
-      libwebp@testing \
+      libwebp \
       mariadb-client \
       nginx \
       pcre \
       php7 \
-      php7-amqp@testing \
+      php7-amqp \
       php7-bcmath \
-      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\
+      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 \
       py-mysqldb \
       py-psycopg2 \
       py-simplejson \
+      rabbitmq-c \
       s6 \
       tar \
- && rm -rf /var/cache/apk/*
-
-RUN ln -s /usr/bin/php7 /usr/bin/php \
+ && 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 \
+ && 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 \
+ && chown -R nobody:nobody /var/www/wallabag
 
 EXPOSE 80
 ENTRYPOINT ["/entrypoint.sh"]

README.md

@@ -29,6 +29,9 @@ Default login is `wallabag:wallabag`.
 - `-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)
+- `-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 POPULATE_DATABASE=...`(defaults to "True". Does the DB has to be populated or is it an existing one)
 
 ## SQLite
 
@@ -41,7 +44,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:/var/www/wallabag/data -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
@@ -58,7 +61,7 @@ $ docker run --name wallabag --link wallabag-db:wallabag-db -e "MYSQL_ROOT_PASSW
 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-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" -p 80:80 wallabag/wallabag
 ```
 
@@ -71,12 +74,18 @@ $ docker run -p 6379:6379 --name redis redis:alpine
 $ docker run -p 80:80 --link redis:redis wallabag/wallabag
 ```
 
-## DB migration
+## Upgrading
 
-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.
+If there is a version upgrade that needs a database migration. The most easy way to do is running the `migrate` command:
 
 ```
-$ docker exec -t wallabag /var/www/wallabag/bin/console doctrine:migrations:migrate --env=prod --no-interaction
+$ 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
@@ -84,7 +93,7 @@ $ docker exec -t wallabag /var/www/wallabag/bin/console doctrine:migrations:migr
 It's a good way to use [docker-compose](https://docs.docker.com/compose/). Example:
 
 ```
-version: '2'
+version: '3'
 services:
   wallabag:
     image: wallabag/wallabag
@@ -102,12 +111,14 @@ services:
       - SYMFONY__ENV__FROM_EMAIL=wallabag@example.com
     ports:
       - "80"
+    volumes:
+      - /opt/wallabag/images:/var/www/wallabag/web/assets/images
   db:
     image: mariadb
     environment:
       - MYSQL_ROOT_PASSWORD=wallaroot
     volumes:
-      - /opt/wallabag:/var/lib/mysql
+      - /opt/wallabag/data:/var/lib/mysql
   redis:
     image: redis:alpine
 ```
@@ -136,3 +147,11 @@ 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:
+```
+$ 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 -e=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

@@ -13,12 +13,17 @@
     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) }}"
+    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_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) }}"
+    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) }}"
 
   tasks:
 
@@ -33,6 +38,8 @@
         - /var/www/wallabag/data/assets
         - /var/www/wallabag/data/db
       notify: chown dir
+      tags:
+        - firstrun
 
     - name: write parameters.yml
       template:
@@ -67,8 +74,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:
@@ -82,7 +93,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:
@@ -93,7 +107,10 @@
         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:
@@ -107,7 +124,10 @@
         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

@@ -8,13 +8,17 @@ parameters:
     database_path: "%kernel.root_dir%/../data/db/wallabag.sqlite"
     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_user:       {{ mailer_user }}
     mailer_password:   {{ mailer_password }}
 
-    locale:            en
+    locale:            {{ locale }}
 
     # A secret key that's used to generate certain security-related tokens
     secret: {{ secret }}
@@ -25,7 +29,7 @@ parameters:
 
     # fosuser stuff
     fosuser_registration: {{ registration }}
-    fosuser_confirmation: true
+    fosuser_confirmation: {{ registration_mail_confirmation }}
 
     from_email: {{ from_email }}
 
@@ -36,9 +40,11 @@ parameters:
     rabbitmq_port: 5672
     rabbitmq_user: guest
     rabbitmq_password: guest
+    rabbitmq_prefetch_count: 10
 
     # Redis processing
     redis_scheme: tcp
     redis_host: redis
     redis_port: 6379
     redis_path: null
+    redis_password: null

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

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

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

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

@@ -8,6 +8,10 @@ parameters:
     database_path: "%kernel.root_dir%/../data/db/wallabag.sqlite"
     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
@@ -44,9 +48,11 @@ parameters:
     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

tests/docker-compose.postgresql.yml

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