Update federation docs
This commit is contained in:
parent
db3dcc6fdc
commit
12af0f462f
5 changed files with 16 additions and 27 deletions
|
@ -20,7 +20,7 @@ before_install:
|
|||
# Change dir
|
||||
- cd docker/travis
|
||||
script:
|
||||
- "./run-tests.sh"
|
||||
- "./run-tests.bash"
|
||||
deploy:
|
||||
provider: script
|
||||
script: bash docker_push.sh
|
||||
|
|
|
@ -1,10 +1,16 @@
|
|||
# Docker Development
|
||||
|
||||
## Dependencies (on Ubuntu)
|
||||
|
||||
```bash
|
||||
sudo apt install git docker-compose
|
||||
sudo systemctl start docker
|
||||
git clone https://github.com/LemmyNet/lemmy
|
||||
```
|
||||
|
||||
## Running
|
||||
|
||||
```bash
|
||||
sudo apt install git docker-compose
|
||||
git clone https://github.com/LemmyNet/lemmy
|
||||
cd lemmy/docker/dev
|
||||
sudo docker-compose up --no-deps --build
|
||||
```
|
||||
|
|
|
@ -1,21 +1,9 @@
|
|||
# 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
|
||||
|
||||
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
|
||||
cd docker/federation
|
||||
./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.
|
||||
|
||||
## Integration tests
|
||||
|
||||
To run a suite of suite of federation integration tests:
|
||||
|
||||
```bash
|
||||
cd docker/federation
|
||||
./run-tests.bash
|
||||
```
|
||||
|
||||
## 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.
|
||||
|
|
|
@ -12,5 +12,9 @@ psql -U lemmy -c "DROP SCHEMA public CASCADE; CREATE SCHEMA public;"
|
|||
|
||||
### Federation
|
||||
|
||||
Install the [Docker development dependencies](contributing_docker_development.md), and execute
|
||||
`docker/federation-test/run-tests.sh`
|
||||
Install the [Docker development dependencies](contributing_docker_development.md), and execute:
|
||||
|
||||
```
|
||||
cd docker/federation
|
||||
./run-tests.bash
|
||||
```
|
||||
|
|
Loading…
Reference in a new issue