From 12af0f462f55a9c102daf832aa5936430f161346 Mon Sep 17 00:00:00 2001 From: Felix Ableitner Date: Mon, 21 Sep 2020 14:02:40 +0200 Subject: [PATCH] Update federation docs --- .travis.yml | 2 +- .../{run-tests.sh => run-tests.bash} | 0 docs/src/contributing_docker_development.md | 10 ++++++-- .../contributing_federation_development.md | 23 +------------------ docs/src/contributing_tests.md | 8 +++++-- 5 files changed, 16 insertions(+), 27 deletions(-) rename docker/federation/{run-tests.sh => run-tests.bash} (100%) diff --git a/.travis.yml b/.travis.yml index 350e0a8e8..648749043 100644 --- a/.travis.yml +++ b/.travis.yml @@ -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 diff --git a/docker/federation/run-tests.sh b/docker/federation/run-tests.bash similarity index 100% rename from docker/federation/run-tests.sh rename to docker/federation/run-tests.bash diff --git a/docs/src/contributing_docker_development.md b/docs/src/contributing_docker_development.md index 23b9fa005..586055a06 100644 --- a/docs/src/contributing_docker_development.md +++ b/docs/src/contributing_docker_development.md @@ -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 ``` diff --git a/docs/src/contributing_federation_development.md b/docs/src/contributing_federation_development.md index 08c4e5ca9..1d2436033 100644 --- a/docs/src/contributing_federation_development.md +++ b/docs/src/contributing_federation_development.md @@ -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. diff --git a/docs/src/contributing_tests.md b/docs/src/contributing_tests.md index e40836c30..494cf5cd9 100644 --- a/docs/src/contributing_tests.md +++ b/docs/src/contributing_tests.md @@ -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 +```