diff options
-rw-r--r-- | Dockerfile | 2 | ||||
-rw-r--r-- | Dockerfile.armhf | 47 | ||||
-rw-r--r-- | doc/md/REST-API.md | 19 | ||||
-rw-r--r-- | doc/md/Upgrade-and-migration.md | 4 | ||||
-rw-r--r-- | mkdocs.yml | 5 | ||||
-rw-r--r-- | tpl/default/pluginsadmin.html | 2 | ||||
-rw-r--r-- | tpl/vintage/page.footer.html | 2 |
7 files changed, 64 insertions, 17 deletions
@@ -25,7 +25,7 @@ RUN cd shaarli \ | |||
25 | 25 | ||
26 | # Stage 4: | 26 | # Stage 4: |
27 | # - Shaarli image | 27 | # - Shaarli image |
28 | FROM alpine:3.7 | 28 | FROM alpine:3.8 |
29 | LABEL maintainer="Shaarli Community" | 29 | LABEL maintainer="Shaarli Community" |
30 | 30 | ||
31 | RUN apk --update --no-cache add \ | 31 | RUN apk --update --no-cache add \ |
diff --git a/Dockerfile.armhf b/Dockerfile.armhf index 5dcc34aa..1185e2df 100644 --- a/Dockerfile.armhf +++ b/Dockerfile.armhf | |||
@@ -1,9 +1,38 @@ | |||
1 | FROM lsiobase/alpine.armhf:3.6 | 1 | # Stage 1: |
2 | # - Copy Shaarli sources | ||
3 | # - Build documentation | ||
4 | FROM arm32v6/alpine:3.8 as docs | ||
5 | ADD . /usr/src/app/shaarli | ||
6 | RUN apk --update --no-cache add py2-pip \ | ||
7 | && cd /usr/src/app/shaarli \ | ||
8 | && pip install --no-cache-dir mkdocs \ | ||
9 | && mkdocs build --clean | ||
10 | |||
11 | # Stage 2: | ||
12 | # - Resolve PHP dependencies with Composer | ||
13 | FROM arm32v6/alpine:3.8 as composer | ||
14 | COPY --from=docs /usr/src/app/shaarli /app/shaarli | ||
15 | RUN apk --update --no-cache add php7-mbstring composer \ | ||
16 | && cd /app/shaarli \ | ||
17 | && composer --prefer-dist --no-dev install | ||
18 | |||
19 | # Stage 3: | ||
20 | # - Frontend dependencies | ||
21 | FROM arm32v6/alpine:3.8 as node | ||
22 | COPY --from=composer /app/shaarli /shaarli | ||
23 | RUN apk --update --no-cache add yarn nodejs-current python2 build-base \ | ||
24 | && cd /shaarli \ | ||
25 | && yarn install \ | ||
26 | && yarn run build \ | ||
27 | && rm -rf node_modules | ||
28 | |||
29 | # Stage 4: | ||
30 | # - Shaarli image | ||
31 | FROM arm32v6/alpine:3.8 | ||
2 | LABEL maintainer="Shaarli Community" | 32 | LABEL maintainer="Shaarli Community" |
3 | 33 | ||
4 | RUN apk --update --no-cache add \ | 34 | RUN apk --update --no-cache add \ |
5 | ca-certificates \ | 35 | ca-certificates \ |
6 | curl \ | ||
7 | nginx \ | 36 | nginx \ |
8 | php7 \ | 37 | php7 \ |
9 | php7-ctype \ | 38 | php7-ctype \ |
@@ -15,7 +44,6 @@ RUN apk --update --no-cache add \ | |||
15 | php7-json \ | 44 | php7-json \ |
16 | php7-mbstring \ | 45 | php7-mbstring \ |
17 | php7-openssl \ | 46 | php7-openssl \ |
18 | php7-phar \ | ||
19 | php7-session \ | 47 | php7-session \ |
20 | php7-xml \ | 48 | php7-xml \ |
21 | php7-zlib \ | 49 | php7-zlib \ |
@@ -25,22 +53,19 @@ COPY .docker/nginx.conf /etc/nginx/nginx.conf | |||
25 | COPY .docker/php-fpm.conf /etc/php7/php-fpm.conf | 53 | COPY .docker/php-fpm.conf /etc/php7/php-fpm.conf |
26 | COPY .docker/services.d /etc/services.d | 54 | COPY .docker/services.d /etc/services.d |
27 | 55 | ||
28 | RUN curl -sS https://getcomposer.org/installer | php7 -- --install-dir=/usr/local/bin --filename=composer \ | 56 | RUN rm -rf /etc/php7/php-fpm.d/www.conf \ |
29 | && rm -rf /etc/php7/php-fpm.d/www.conf \ | ||
30 | && sed -i 's/post_max_size.*/post_max_size = 10M/' /etc/php7/php.ini \ | 57 | && sed -i 's/post_max_size.*/post_max_size = 10M/' /etc/php7/php.ini \ |
31 | && sed -i 's/upload_max_filesize.*/upload_max_filesize = 10M/' /etc/php7/php.ini | 58 | && sed -i 's/upload_max_filesize.*/upload_max_filesize = 10M/' /etc/php7/php.ini |
32 | 59 | ||
33 | 60 | ||
34 | WORKDIR /var/www | 61 | WORKDIR /var/www |
35 | RUN curl -L https://github.com/shaarli/Shaarli/archive/master.tar.gz | tar xzf - \ | 62 | COPY --from=node /shaarli /var/www/shaarli |
36 | && mv Shaarli-master shaarli \ | 63 | |
37 | && cd shaarli \ | 64 | RUN chown -R nginx:nginx . \ |
38 | && composer --prefer-dist --no-dev install \ | ||
39 | && rm -rf ~/.composer \ | ||
40 | && chown -R nginx:nginx . \ | ||
41 | && ln -sf /dev/stdout /var/log/nginx/shaarli.access.log \ | 65 | && ln -sf /dev/stdout /var/log/nginx/shaarli.access.log \ |
42 | && ln -sf /dev/stderr /var/log/nginx/shaarli.error.log | 66 | && ln -sf /dev/stderr /var/log/nginx/shaarli.error.log |
43 | 67 | ||
68 | VOLUME /var/www/shaarli/cache | ||
44 | VOLUME /var/www/shaarli/data | 69 | VOLUME /var/www/shaarli/data |
45 | 70 | ||
46 | EXPOSE 80 | 71 | EXPOSE 80 |
diff --git a/doc/md/REST-API.md b/doc/md/REST-API.md index c016de56..11bd1cd2 100644 --- a/doc/md/REST-API.md +++ b/doc/md/REST-API.md | |||
@@ -152,3 +152,22 @@ See the reference API client: | |||
152 | 152 | ||
153 | - [Documentation](http://python-shaarli-client.readthedocs.io/en/latest/) on ReadTheDocs | 153 | - [Documentation](http://python-shaarli-client.readthedocs.io/en/latest/) on ReadTheDocs |
154 | - [python-shaarli-client](https://github.com/shaarli/python-shaarli-client) on Github | 154 | - [python-shaarli-client](https://github.com/shaarli/python-shaarli-client) on Github |
155 | |||
156 | ## Troubleshooting | ||
157 | |||
158 | ### Debug mode | ||
159 | |||
160 | > This should never be used in a production environment. | ||
161 | |||
162 | For security reasons, authentication issues will always return an `HTTP 401` error code without any detail. | ||
163 | |||
164 | It is possible to enable the debug mode in `config.json.php` | ||
165 | to get the actual error message in the HTTP response body with: | ||
166 | |||
167 | ```json | ||
168 | { | ||
169 | "dev": { | ||
170 | "debug": true | ||
171 | } | ||
172 | } | ||
173 | ``` | ||
diff --git a/doc/md/Upgrade-and-migration.md b/doc/md/Upgrade-and-migration.md index 451ca36d..d5682a34 100644 --- a/doc/md/Upgrade-and-migration.md +++ b/doc/md/Upgrade-and-migration.md | |||
@@ -27,7 +27,7 @@ As all user data is kept under `data`, this is the only directory you need to wo | |||
27 | 27 | ||
28 | - backup the `data` directory | 28 | - backup the `data` directory |
29 | - install or update Shaarli: | 29 | - install or update Shaarli: |
30 | - fresh installation - see [Download and installation](Download-and-installation) | 30 | - fresh installation - see [Download and Installation](Download-and-Installation) |
31 | - update - see the following sections | 31 | - update - see the following sections |
32 | - check or restore the `data` directory | 32 | - check or restore the `data` directory |
33 | 33 | ||
@@ -35,7 +35,7 @@ As all user data is kept under `data`, this is the only directory you need to wo | |||
35 | 35 | ||
36 | All tagged revisions can be downloaded as tarballs or ZIP archives from the [releases](https://github.com/shaarli/Shaarli/releases) page. | 36 | All tagged revisions can be downloaded as tarballs or ZIP archives from the [releases](https://github.com/shaarli/Shaarli/releases) page. |
37 | 37 | ||
38 | We recommend that you use the latest release tarball with the `-full` suffix. It contains the dependencies, please read [Download and installation](Download-and-installation) for `git` complete instructions. | 38 | We recommend that you use the latest release tarball with the `-full` suffix. It contains the dependencies, please read [Download and Installation](Download-and-Installation) for `git` complete instructions. |
39 | 39 | ||
40 | Once downloaded, extract the archive locally and update your remote installation (e.g. via FTP) -be sure you keep the content of the `data` directory! | 40 | Once downloaded, extract the archive locally and update your remote installation (e.g. via FTP) -be sure you keep the content of the `data` directory! |
41 | 41 | ||
@@ -5,7 +5,10 @@ site_description: The personal, minimalist, super-fast, database free, bookmarki | |||
5 | theme: readthedocs | 5 | theme: readthedocs |
6 | docs_dir: doc/md | 6 | docs_dir: doc/md |
7 | site_dir: doc/html | 7 | site_dir: doc/html |
8 | strict: true | 8 | # Disable strict mode until ReadTheDocs provides up-to-date MkDocs settings: |
9 | # - https://github.com/shaarli/Shaarli/issues/1179 | ||
10 | # - https://github.com/rtfd/readthedocs.org/issues/4314 | ||
11 | # strict: true | ||
9 | 12 | ||
10 | pages: | 13 | pages: |
11 | - Home: index.md | 14 | - Home: index.md |
diff --git a/tpl/default/pluginsadmin.html b/tpl/default/pluginsadmin.html index 8f2597df..82041972 100644 --- a/tpl/default/pluginsadmin.html +++ b/tpl/default/pluginsadmin.html | |||
@@ -117,7 +117,7 @@ | |||
117 | 117 | ||
118 | <div class="center more"> | 118 | <div class="center more"> |
119 | {"More plugins available"|t} | 119 | {"More plugins available"|t} |
120 | <a href="doc/Community-&-Related-software.html#third-party-plugins">{"in the documentation"|t}</a>. | 120 | <a href="doc/html/Community-&-Related-software/#third-party-plugins">{"in the documentation"|t}</a>. |
121 | </div> | 121 | </div> |
122 | <div class="center"> | 122 | <div class="center"> |
123 | <input type="submit" value="{'Save'|t}" name="save"> | 123 | <input type="submit" value="{'Save'|t}" name="save"> |
diff --git a/tpl/vintage/page.footer.html b/tpl/vintage/page.footer.html index f409721e..a3380841 100644 --- a/tpl/vintage/page.footer.html +++ b/tpl/vintage/page.footer.html | |||
@@ -1,7 +1,7 @@ | |||
1 | <div id="footer"> | 1 | <div id="footer"> |
2 | <strong><a href="https://github.com/shaarli/Shaarli">Shaarli</a></strong> | 2 | <strong><a href="https://github.com/shaarli/Shaarli">Shaarli</a></strong> |
3 | - The personal, minimalist, super-fast, database free, bookmarking service by the Shaarli community | 3 | - The personal, minimalist, super-fast, database free, bookmarking service by the Shaarli community |
4 | - <a href="doc/Home.html" rel="nofollow">Help/documentation</a> | 4 | - <a href="doc/html/index.html" rel="nofollow">Help/documentation</a> |
5 | {loop="$plugins_footer.text"} | 5 | {loop="$plugins_footer.text"} |
6 | {$value} | 6 | {$value} |
7 | {/loop} | 7 | {/loop} |