Update README for Nix; add TODO
This commit is contained in:
parent
e95f9e4433
commit
a04b129e37
20
README
20
README
@ -24,21 +24,13 @@ You shouldn't. This is free and open-source software which you can run on your o
|
|||||||
|
|
||||||
DEPLOYMENT
|
DEPLOYMENT
|
||||||
|
|
||||||
purr is intended to run in a docker container.
|
Use Nix with flakes enabled.
|
||||||
This repo's Stack project is configured to use a musl-based docker container for builds.
|
|
||||||
Assuming your working directory is inside of this repository:
|
|
||||||
|
|
||||||
1. Copy "examples/config.dhall" to ./config.dhall - configure this file appropriately.
|
Build binary and run natively:
|
||||||
- Use `openssl rand -hex 10` to generate an encryption key for "dbKey"
|
nix build && ./result/bin/Purr-musl
|
||||||
2. Copy "examples/Dockerfile" to ./Dockerfile
|
|
||||||
3. If using default database file location, run: `mkdir ./data; touch ./data/Purr.sqlite`
|
Build and add Docker image to local registry:
|
||||||
4. Run `chmod +x build-docker`
|
nix build .#purrImage --impure && docker load < result
|
||||||
5. Run `./build-docker $IMAGE_NAME` to complete the initial Stack build and create the container
|
|
||||||
6. Orchestrate the container as desired
|
|
||||||
- docker run -d -v "$(pwd -P)/data/Purr.sqlite:/app/data/Purr.sqlite" \
|
|
||||||
-v "$(pwd -P)/config.dhall:/app/config.dhall" \
|
|
||||||
-p 5195:3000 purr
|
|
||||||
|- An example docker-stack.yml is provided: `docker stack deploy -c docker-stack.yml purr`
|
|
||||||
|
|
||||||
DEVELOPMENT & SUPPORT
|
DEVELOPMENT & SUPPORT
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user