yetangitu/timelimit-server
1
0
Fork 0
mirror of https://codeberg.org/timelimit/timelimit-server.git synced 2025-10-03 09:49:32 +02:00
Code Issues Projects Releases Wiki Activity

Adjust the documentation related to docker

Browse source
This commit is contained in:
Jonas Lochmann 2021-06-21 02:00:00 +02:00
parent 70a4d36b16
commit 82230f6c40
No known key found for this signature in database
GPG key ID: 8B8C9AEE10FA5B36
2 changed files with 10 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

20
docs/usage/docker.md
View file

@ -4,22 +4,17 @@ You can run the timelimit server with docker. Here are two example configuration
## Important ## Important
The ``image: 'timelimit-server:latest'`` will not work out of the box. Watch out to actually rebuild the images and restart the containers after updates (for example using ``docker-compose up --build``).
You have to build this image yourself (using ``sudo docker build -t timelimit-server --no-cache --pull .``
within the root directory of this git repository) or you can replace it by
``image: docker.timelimit.io/timelimit-server`` which will use prebuilt docker
images.
In case of self building the image, don't forget to run ``docker-compose up`` again
to make docker use the new image.
## example docker-compose.yml with included database ## example docker-compose.yml with included database
``` ```
# change the passwords and use https://docs.docker.com/compose/environment-variables/
# to keep sensitives value in a .env file while using ${VAR_NAME} here instead
version: '3' version: '3'
services: services:
api: api:
image: 'timelimit-server:latest' build: /path/to/the/timelimit/source/code
environment: environment:
NODE_ENV: production NODE_ENV: production
DATABASE_URL: mariadb://timelimit:timelimitpassword@database:3306/timelimit DATABASE_URL: mariadb://timelimit:timelimitpassword@database:3306/timelimit
@ -62,10 +57,12 @@ before it starts working.
## example docker-compose.yml with external databases ## example docker-compose.yml with external databases
``` ```
version: '2' # change the passwords and use https://docs.docker.com/compose/environment-variables/
# to keep sensitives value in a .env file while using ${VAR_NAME} here instead
version: '3'
services: services:
api: api:
image: 'timelimit-server:latest' build: /path/to/the/timelimit/source/code
environment: environment:
NODE_ENV: production NODE_ENV: production
DATABASE_URL: postgres://user:pass@example.com:5432/dbname DATABASE_URL: postgres://user:pass@example.com:5432/dbname
@ -87,4 +84,5 @@ services:
# - "9000:8080" # - "9000:8080"
# in case the database runs outside of docker and you don't want to use the host network mode, see # in case the database runs outside of docker and you don't want to use the host network mode, see
# https://forums.docker.com/t/accessing-host-machine-from-within-docker-container/14248 # https://forums.docker.com/t/accessing-host-machine-from-within-docker-container/14248
# or don't use docker ...
``` ```

2
docs/usage/running.md
View file

@ -4,7 +4,7 @@ There are 3 options for running this application:
Option 1: Build a docker image and use it Option 1: Build a docker image and use it
Option 2: Install Node.JS (see [npm-commands](./npm-commands.md)) Option 2: Install Node.JS (see [npm-commands](./npm-commands.md))
Option 3: Use a prebuilt docker image Option 3: Use ``timelimit-server-setup.sh`` if there is nothing yet at your system
After starting it, you can open ``http://server/time`` to test it, After starting it, you can open ``http://server/time`` to test it,
it should show a timestamp it should show a timestamp