diff options
author | Seth For Privacy <40500387+sethforprivacy@users.noreply.github.com> | 2024-04-23 10:06:15 -0400 |
---|---|---|
committer | GitHub <noreply@github.com> | 2024-04-23 14:06:15 +0000 |
commit | 91926dd2cd0a2008adbeb1b9fec12d84b8496204 (patch) | |
tree | 440d274b37fdd92aacf59ca5c7cd25591bb04731 /README.md | |
parent | 3c494018142b5a1c236681eb9a2abc9010ea1014 (diff) | |
download | sentrum-91926dd2cd0a2008adbeb1b9fec12d84b8496204.tar.gz sentrum-91926dd2cd0a2008adbeb1b9fec12d84b8496204.tar.bz2 sentrum-91926dd2cd0a2008adbeb1b9fec12d84b8496204.zip |
Add Dockerfile and GAs for Docker image deployment
* Initial Dockerfile and Github Actions
* Properly name final Docker build stage
* Add tag for package.version
* Correct cargo-get syntax
* Fix version tagging and add sentrum.toml to .gitignore
* Fix newlines and add Docker examples
* Fix branch on Github Action and minor copy update
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 47 |
1 files changed, 46 insertions, 1 deletions
@@ -346,7 +346,52 @@ sudo systemclt enable --now sentrum.service 6. Check the logs with `journalctl -fu sentrum` -# Future Work +## Docker + +To run sentrum using Docker, you can either build the image yourself or use the prebuilt image. + +### Building the image + +To build the image from source, run the following: + +```bash +git clone https://github.com/sommerfelddev/sentrum.git +cd sentrum +docker build -t sentrum:local . +``` + +To use the prebuilt image, simply pull from GHCR: + +```bash +docker pull docker pull ghcr.io/sommerfelddev/sentrum:latest +``` + +Note that there are two types of tags: + +`latest`: a tag from the latest commit to master +`x.x.x`: (i.e. `0.1.1`) a tag of the corresponding sentrum version + +### Running the image + +To run the image, simply run the following, passing in the `sentrum.toml` file you created and configured earlier: + +```bash +docker run --rm -it --volume ./sentrum.toml:/sentrum.toml ghcr.io/sommerfelddev/sentrum:latest +``` + +If using Docker compose, you can configure the service as follows: + +```yaml +services: + sentrum: + container_name: sentrum + image: ghcr.io/sommerfelddev/sentrum:latest + restart: unless-stopped + volumes: + - ./sentrum.toml:/sentrum.toml +``` + +## Future Work * More action types: - Matrix DM |