diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/src/about_guide.md | 2 | ||||
| -rw-r--r-- | docs/src/contributing_federation_development.md | 31 |
2 files changed, 28 insertions, 5 deletions
diff --git a/docs/src/about_guide.md b/docs/src/about_guide.md index 16788ab9..6f709b58 100644 --- a/docs/src/about_guide.md +++ b/docs/src/about_guide.md @@ -3,7 +3,7 @@ Start typing... - `@a_user_name` to get a list of usernames. -- `#a_community` to get a list of communities. +- `!a_community` to get a list of communities. - `:emoji` to get a list of emojis. ## Sorting diff --git a/docs/src/contributing_federation_development.md b/docs/src/contributing_federation_development.md index 80c9ec7e..520a6127 100644 --- a/docs/src/contributing_federation_development.md +++ b/docs/src/contributing_federation_development.md @@ -15,7 +15,7 @@ git checkout federation git pull federation federation ``` -## Running +## Running locally You need to have the following packages installed, the Docker service needs to be running. @@ -31,7 +31,30 @@ cd dev/federation-test ``` After the build is finished and the docker-compose setup is running, open [127.0.0.1:8540](http://127.0.0.1:8540) and -[127.0.0.1:8541](http://127.0.0.1:8541) in your browser to use the test instances. You can login as admin with -username `lemmy` and password `lemmy`, or create new accounts. +[127.0.0.1:8550](http://127.0.0.1:8550) in your browser to use the test instances. You can login as admin with +username `lemmy_alpha` and `lemmy_beta` respectively, with password `lemmy`. -Please get in touch if you want to contribute to this, so we can coordinate things and avoid duplicate work. +## Running on a server + +Note that federation is currently in alpha. Only use it for testing, not on any production server, and be aware +that you might have to wipe the instance data at one point or another. + +Follow the normal installation instructions, either with [Ansible](administration_install_ansible.md) or +[manually](administration_install_docker.md). Then replace the line `image: dessalines/lemmy:v0.x.x` in +`/lemmy/docker-compose.yml` with `image: dessalines/lemmy:federation`. Also add the following in +`/lemmy/lemmy.hjson`: + +``` + federation: { + enabled: true + allowed_instances: example.com + } +``` + +Afterwards, and whenver you want to update to the latest version, run these commands on the server: + +``` +cd /lemmy/ +sudo docker-compose pull +sudo docker-compose up -d +``` |