From 40c0cf1c3f04667011c7d239498ec49d7294bbbb Mon Sep 17 00:00:00 2001 From: thhsh Date: Wed, 5 Mar 2025 20:00:01 -0500 Subject: [PATCH] docs: update README.md --- README.md | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9c8e5a5..44063f7 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,16 @@ -# git +# git-server -The pieces that make up the git.starcat.systems Forgejo server. \ No newline at end of file +The pieces that make up the git.starcat.systems Forgejo server. + +Contents: +- `forgejo`: + - `app_ini` > `app.ini`: the Forgejo configuration file + - `custom`: customizations/tweaks made to Forgejo's appearance +- `caddy`: + - `Caddyfile`: the Caddy server configuration (reverse proxies Forgejo) + +> [!important] +> **This repo is mirrored** between https://git.starcat.systems/starcat-infra/git-server and https://gitlab.com/starcatsys-mirror/starcat-infra/git-server. The version hosted on GitLab is a **read-only** version. Please use https://git.starcat.systems/starcat-infra/git-server for all interaction. + +> [!note] +> **An important note on licensing:** The changes and customizations to configurations, projects, and files in this repo are released under the MIT license. Other files, including those from Forgejo/Codeberg, Caddy, and images/logos may be released under different licenses. \ No newline at end of file