From d80e13b6fcb47932a9e7d2dc4ff0c18cf47d01bb Mon Sep 17 00:00:00 2001 From: Glenn Date: Tue, 16 Aug 2022 21:57:12 +0200 Subject: [PATCH] Update doc --- README.md | 18 ++++++++++-------- docker-compose.yml | 8 ++++++-- 2 files changed, 16 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index e5ebda0..e754766 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,18 @@ +# Usage -Please define the following variables +Please define the following environment variables -GITIT_USER_EMAIL: glenux@glenux.net -GITIT_USER_NAME: Glenn Y. Rolland -GITIT_REMOTE_REPOSITORY: git@github.com/glenux/somewhere -GITIT_REMOTE_DOMAIN: github.com +* GITIT_USER_EMAIL: jon.smith@example.com +* GITIT_USER_NAME: Jon Smith +* GITIT_REMOTE_REPOSITORY: git@example.com/jon.smith/somewhere +* GITIT_REMOTE_DOMAIN: example.com Please mount the following volumes -/var/lib/dokku/data/storage/cryptochemists-wiki-prod => /data +* /path/to/your/data => /data -You can also add a cron task to mirror the wiki on a regular basis +It is also strongly advised to run a cron task to mirror the wiki on a regular +basis # server cron jobs MAILTO="admin@server.com" @@ -34,7 +36,7 @@ You can also add a cron task to mirror the wiki on a regular basis ### PLACE ALL CRON TASKS BELOW # removes unresponsive users from the subscriber list to decrease bounce rates - 0 * * * * dokku dokku --rm run cryptochemists-wiki-prod sh -c "cd wikidata && git push --set-upstream origin master" + 0 * * * * docker run --rm thecontainer sh -c "cd wikidata && git push --set-upstream origin master" ### PLACE ALL CRON TASKS ABOVE, DO NOT REMOVE THE WHITESPACE AFTER THIS LINE diff --git a/docker-compose.yml b/docker-compose.yml index 2691263..333e625 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -1,5 +1,7 @@ +--- version: '3' -services: + +wiki: gitit: build: context: . @@ -8,7 +10,9 @@ services: GIT_COMMITTER_NAME: "Collapse Wiki" GIT_COMMITTER_EMAIL: "admin@collapse.wiki" volumes: - - ./wiki:/data + - wiki_data:/data ports: - 5001:5001 +volumes: + wiki_data: