diff options
| author | Xe Iaso <me@xeiaso.net> | 2024-05-09 13:05:35 -0400 |
|---|---|---|
| committer | Xe Iaso <me@xeiaso.net> | 2024-05-09 13:05:35 -0400 |
| commit | d1eaa71c8a05bb9febe4e34c27c3c65d2b442568 (patch) | |
| tree | 895e53958f6b71815568bfbee25185024c436231 /cmd/sapientwindex | |
| parent | 3a943a2986151aefc61923cef5b2c84edb266279 (diff) | |
| download | x-d1eaa71c8a05bb9febe4e34c27c3c65d2b442568.tar.xz x-d1eaa71c8a05bb9febe4e34c27c3c65d2b442568.zip | |
cmd/sapientwindex: clean up manual
Signed-off-by: Xe Iaso <me@xeiaso.net>
Diffstat (limited to 'cmd/sapientwindex')
| -rw-r--r-- | cmd/sapientwindex/README.md | 19 |
1 files changed, 10 insertions, 9 deletions
diff --git a/cmd/sapientwindex/README.md b/cmd/sapientwindex/README.md index dd6a3b7..3ea7dd1 100644 --- a/cmd/sapientwindex/README.md +++ b/cmd/sapientwindex/README.md @@ -1,11 +1,11 @@ # sapientwindex sapientwindex is a Reddit -> Discord bot. It will monitor a subreddit -(or group of subreddits) and then post any new posts to a given -channel by webhook. +(or group of subreddits) and then post any new posts it finds to a +given webhook. Avatars are automatically created using Stable Diffusion. <details> - <summary>If you know what "Kubernetes" means and you have your own cluster</summary> + <summary>If you know what a Kubernetes cluster is and you have one already</summary> If you have a Kubernetes cluster, create a generic secret called `sapientwindex` in the default namespace with the following fields: @@ -27,6 +27,12 @@ namespace is desired. </details> +## Hosted option + +For a nominal fee, I can host a copy of this bot for you on my +homelab. Please [contact me](sapientwindexsales@xeserv.us) to arrange +terms for this hosted option. + ## Prerequisites for self-hosting In order to host this yourself, you need the following things: @@ -40,6 +46,7 @@ In order to host this yourself, you need the following things: 1. Install [Docker Desktop](https://docs.docker.com/desktop/install/windows-install/) + to run the sapientwindex container. 1. Run the following command to start the sapientwindex service: ``` docker run --name sapientwindex -e DISCORD_WEBHOOK_URL=<paste webhook here> -e REDDIT_USERNAME=<your reddit username> -e SUBREDDITS=<list,of,subreddits> -dit ghcr.io/xe/x/sapientwindex:latest @@ -73,12 +80,6 @@ To update the bot, run these commands: Updates to the bot will be done very infrequently. -## Hosted option - -For a nominal fee, I can host a copy of this bot for you on my -homelab. Please [contact me](sapientwindexsales@xeserv.us) to arrange -terms for this hosted option. - ## Support Support is done by [GitHub issues](https://github.com/Xe/x/issues) on |