From b3d2aea1ce6d389b934b00a767709cbc4aaa40b0 Mon Sep 17 00:00:00 2001 From: Marten <43725244+Tiyn@users.noreply.github.com> Date: Fri, 13 Nov 2020 13:13:13 +0100 Subject: [PATCH] Update README.md --- README.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 1cd6d06..d459bfc 100644 --- a/README.md +++ b/README.md @@ -23,16 +23,15 @@ I however just want to put my markdown files in a directory and get a working wi - [x] Navigation - [x] More advanced namespaces - [x] Header - - [ ] Random article - - [ ] Search bar in header + - [ ] Random article + - [ ] Search bar in header - [x] Footer - [x] Switchable CSS - [x] CSS dark-theme - [x] CSS light-theme - [x] Config file - [x] Docker installation - - [ ] Enable variables/environment variables -- [ ] Logo +- [x] Logo ## Usage @@ -45,8 +44,8 @@ The first line of each document is reserved as the title of the document. ### PIP/Python -- `git clone https://github.com/tiyn/tiyny-wiki` -- `cd tiyny-wiki/src` +- `git clone https://github.com/tiyn/amphora-wiki` +- `cd amphora-wiki/src` - edit the `config.py` file according to your needs - `pip3install -r requirements.txt` - install depenencies - run `python app.py` @@ -78,4 +77,7 @@ Set the following ports with the -p tag. #### Example run-command +Either use the docker image `tiynger/amphora-wiki` or run `docker build . -t amphora-wiki` in the top directory of this repository. +If so you need to change the command below apropiately (`tiynger/amphora-wiki` to `amphora-wiki`). + `docker run --name wiki --restart unless-stopped -v /config.py:/wiki/src/config.py -v entries:/wiki/src/templates/entry -p 80:5000 -d tiynger/tiyny-wiki`