Browse Source

Update federation docs

tags/v0.7.59
Felix Ableitner 2 months ago
parent
commit
12af0f462f
5 changed files with 15 additions and 26 deletions
  1. +1
    -1
      .travis.yml
  2. +0
    -0
      docker/federation/run-tests.bash
  3. +7
    -1
      docs/src/contributing_docker_development.md
  4. +1
    -22
      docs/src/contributing_federation_development.md
  5. +6
    -2
      docs/src/contributing_tests.md

+ 1
- 1
.travis.yml View File

@@ -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


docker/federation/run-tests.sh → docker/federation/run-tests.bash View File


+ 7
- 1
docs/src/contributing_docker_development.md View File

@@ -1,10 +1,16 @@
# Docker Development

## Running
## Dependencies (on Ubuntu)

```bash
sudo apt install git docker-compose
sudo systemctl start docker
git clone https://github.com/LemmyNet/lemmy
```

## Running

```bash
cd lemmy/docker/dev
sudo docker-compose up --no-deps --build
```


+ 1
- 22
docs/src/contributing_federation_development.md View File

@@ -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.

- docker
- docker-compose
Install the dependencies as described in [Docker development](contributing_docker_development.md). Then run the following

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.


+ 6
- 2
docs/src/contributing_tests.md View File

@@ -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…
Cancel
Save