Update federation docs

This commit is contained in:
Felix Ableitner 2020-09-21 14:02:40 +02:00
parent db3dcc6fdc
commit 12af0f462f
5 changed files with 16 additions and 27 deletions

View file

@ -20,7 +20,7 @@ before_install:
# Change dir # Change dir
- cd docker/travis - cd docker/travis
script: script:
- "./run-tests.sh" - "./run-tests.bash"
deploy: deploy:
provider: script provider: script
script: bash docker_push.sh script: bash docker_push.sh

View file

@ -1,10 +1,16 @@
# Docker Development # Docker Development
## Dependencies (on Ubuntu)
```bash
sudo apt install git docker-compose
sudo systemctl start docker
git clone https://github.com/LemmyNet/lemmy
```
## Running ## Running
```bash ```bash
sudo apt install git docker-compose
git clone https://github.com/LemmyNet/lemmy
cd lemmy/docker/dev cd lemmy/docker/dev
sudo docker-compose up --no-deps --build sudo docker-compose up --no-deps --build
``` ```

View file

@ -1,21 +1,9 @@
# Federation Development # Federation Development
## Setup
If you don't have a local clone of the Lemmy repo yet, just run the following command:
```bash
git clone https://github.com/LemmyNet/lemmy
```
## Running locally ## Running locally
You need to have the following packages installed, the Docker service needs to be running. Install the dependencies as described in [Docker development](contributing_docker_development.md). Then run the following
- docker
- docker-compose
Then run the following
```bash ```bash
cd docker/federation cd docker/federation
./start-local-instances.bash ./start-local-instances.bash
@ -40,15 +28,6 @@ To start federation between instances, visit one of them and search for a user,
Firefox containers are a good way to test them interacting. Firefox containers are a good way to test them interacting.
## Integration tests
To run a suite of suite of federation integration tests:
```bash
cd docker/federation
./run-tests.bash
```
## Running on a server ## 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 turning on federation may break your instance. Note that federation is currently in alpha. **Only use it for testing**, not on any production server, and be aware that turning on federation may break your instance.

View file

@ -12,5 +12,9 @@ psql -U lemmy -c "DROP SCHEMA public CASCADE; CREATE SCHEMA public;"
### Federation ### Federation
Install the [Docker development dependencies](contributing_docker_development.md), and execute Install the [Docker development dependencies](contributing_docker_development.md), and execute:
`docker/federation-test/run-tests.sh`
```
cd docker/federation
./run-tests.bash
```