From 2663ed49e7f0a53156efc11dc89d8a215f005278 Mon Sep 17 00:00:00 2001 From: "Patrik J. Braun" Date: Sun, 29 Dec 2019 10:45:01 +0100 Subject: [PATCH] readme update --- README.md | 10 ++++++---- docker/alpine/Dockerfile.build | 2 +- docker/debian-stretch/Dockerfile.build | 2 +- 3 files changed, 8 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 4dfbefb4..1bf0aaa0 100644 --- a/README.md +++ b/README.md @@ -29,14 +29,15 @@ Live Demo @ heroku: https://pigallery2.herokuapp.com/ ## 1. Getting started (also works on Raspberry Pi) -### 1.1 Run with Docker +### 1.1 Run with Docker (recommended) If you have `docker` and don't want to install all the dependencies, you can use one of our docker build. For configuration and docker-compose files read more [here](docker/README.md) or check all builds: https://hub.docker.com/r/bpatrik/pigallery2/tags/ -**Note**: You dont need to do the installation steps if you are using docker. +**Note**: You dont need to do the rest of the installation steps if you are using docker. ### 1.2 Direct Install +As an alternative, you can also directly install nodejs and the app and run it natively. ### 1.2.0 [Install NodeJs](https://nodejs.org/en/download/) Download and extract ```bash @@ -66,7 +67,6 @@ npm install npm build ``` **Note**: if you run `npm run create-release`, it creates a clean, minified, production ready version from the app in the `release` folder, that is ready to deploy. - **Note2**: you can use `npm run create-release -- --languages=fr,ro` to restrict building to the listed languages (english is added by default) #### 1.2.2 Run PiGallery2 @@ -77,7 +77,9 @@ To configure it, run `PiGallery2` first to create `config.json` file, then edit The app has a nice UI for settings, you may use that too. Default user: `admin` pass: `admin` - +**Note**: First run, you might have file access issues and port 80 issue. +Running `npm start -- --Server-port=8080` will start the app on port 8080 that does not require `root` +Adding read/write permissions to all files can solve the file access issue `chmod -R o-w .`, see [#98](https://github.com/bpatrik/pigallery2/issues/98). ### 1.3 Advanced configuration You can set up the app the following ways: diff --git a/docker/alpine/Dockerfile.build b/docker/alpine/Dockerfile.build index 8dc3de49..c6354626 100644 --- a/docker/alpine/Dockerfile.build +++ b/docker/alpine/Dockerfile.build @@ -24,6 +24,6 @@ ENV NODE_ENV=production RUN apk add ffmpeg COPY --from=builder /app /app VOLUME ["/app/data/config", "/app/data/db", "/app/data/images", "/app/data/tmp"] -HEALTHCHECK --interval=30s --timeout=10s --retries=4 --start-period=60s \ +HEALTHCHECK --interval=30s --timeout=20s --retries=4 --start-period=60s \ CMD wget --quiet --tries=1 --no-check-certificate --spider \ http://localhost:80 || exit 1 diff --git a/docker/debian-stretch/Dockerfile.build b/docker/debian-stretch/Dockerfile.build index e842051b..0728b96d 100644 --- a/docker/debian-stretch/Dockerfile.build +++ b/docker/debian-stretch/Dockerfile.build @@ -23,6 +23,6 @@ ENV NODE_ENV=production RUN apt-get update && apt-get install -y ffmpeg COPY --from=builder /app /app VOLUME ["/app/data/config", "/app/data/db", "/app/data/images", "/app/data/tmp"] -HEALTHCHECK --interval=30s --timeout=10s --retries=4 --start-period=60s \ +HEALTHCHECK --interval=30s --timeout=20s --retries=4 --start-period=60s \ CMD wget --quiet --tries=1 --no-check-certificate --spider \ http://localhost:80 || exit 1