diff --git a/README.md b/README.md index 64f55c4..d5e7521 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ It uses the [dracula](https://github.com/dracula/dracula-theme) colors. ![Screenshot of the application](./squipnotes.png) ## Changing the code syntax highlight theme -* Install pygmentyze (must be in your path): +* Install pygmentyze (it then must be in your path; pip generally installs things in ~/.local/bin when using a Linux OS): ``` python3 pip install pygmentize ``` @@ -23,5 +23,21 @@ pygmentize -S dracula -f html -a .codehilite > styles.css ``` * Replace all css for .codehilite in src/static/main.css with what's in styles.css +## Run with Docker +### Using traefik +If you use traefik, you only have to change the url in the label "traefik.http.routers.sqnotes.rule". You can also modify the labels to rename the service from "sqnotes" to anything else. + +Then start the service. It will create the image and start it for you: +```bash +docker-compose up -d +``` + +### Without using traefik +Simply uncomment lines 13 and 14 to expose port 8080. You can leave the rest. +Then start the container: +```bash +docker-compose up -d +``` + ## Future features, todo * Replace pickle with sqlite or smth diff --git a/squipnotes.png b/squipnotes.png index ea726d2..e15007e 100644 Binary files a/squipnotes.png and b/squipnotes.png differ