summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--Running-federated-Gitea.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/Running-federated-Gitea.md b/Running-federated-Gitea.md
new file mode 100644
index 0000000..1fecf5a
--- /dev/null
+++ b/Running-federated-Gitea.md
@@ -0,0 +1,17 @@
+## Preparation
+
+Make sure you have backups if your Gitea instance contains any important data. The Gitea federation code will make possibly unexpected changes to your database.
+
+You can also join https://matrix.to/#/#forgefederation:matrix.batsense.net and https://matrix.to/#/#gitea-federation-chat:matrix.org to chat with Gitea and forge federation developers or report bugs and regressions.
+
+## Quick and easy install
+
+[Gergely Nagy set up daily Docker builds](https://trunk.mad-scientist.club/@algernon/108662104734390510) of this repository. Run `docker pull the.mad-scientist.club/federation/gitea:latest` and you're ready to run federated Gitea! Note that these Docker images are built by a third-party and not affiliated with @Ta180m or the Gitea team.
+
+## Compile it yourself
+
+First, clone this repository. If you would like to build a Docker image, there is a `Dockerfile` in this repo. If you would like to build a binary, run `TAGS="bindata" make`.
+
+## Configuration
+
+Make sure you have `ENABLED=true` in the [federation](https://docs.gitea.io/en-us/config-cheat-sheet/#federation-federation) section of your Gitea config. \ No newline at end of file