aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorFChannel0 <77419041+FChannel0@users.noreply.github.com>2021-08-17 12:41:20 -0700
committerGitHub <noreply@github.com>2021-08-17 12:41:20 -0700
commit21917eb2ea72fe40d70c2c991e821aace5430c23 (patch)
tree4dd4122a8661231181ead7c00bdc92c3d498589f /README.md
parent149f71db2d6e1b704ff2712393da5276a622d4dd (diff)
parentc8e0fb94bac60679ccebfcdec9cefb32674b2eec (diff)
Merge pull request #51 from KushBlazingJudah/development
go fmt and docker configuration
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 12 insertions, 1 deletions
diff --git a/README.md b/README.md
index a05eed7..4d4bba2 100644
--- a/README.md
+++ b/README.md
@@ -73,6 +73,8 @@ Any contributions or suggestions are appreciated. Best way to give immediate fee
`instancesalt:put your salt string here` Used for secure tripcodes currently.
+ `redis:redis://localhost` Used for Redis. This should be `redis://localhost` in most cases.
+
Currently e-mail is not implemented to do anything special, but the code is in place
@@ -151,7 +153,16 @@ server {
### Docker
-`Please consider submitting a pull request if you set up a FChannel instance with Docker with instructions on how to do so`
+A Dockerfile is provided, and an example `docker-compose.yml` exists to base your Docker setup on.
+You should use the `config-init.docker` file to configure it and it will work more or less out of the box with it, you should just need some minor configuration changes to test it out.
+
+You may need to set up your `config` like this to access the mod tools if you get stuck when logging in:
+```
+instance:fchan.xyz:PORT GOES HERE
+instanceport:PORT GOES HERE
+```
+
+See #12 for more details.
# Support