aboutsummaryrefslogtreecommitdiff
path: root/README.org
diff options
context:
space:
mode:
authorArun Isaac2022-03-19 23:48:17 +0530
committerArun Isaac2022-03-19 23:51:28 +0530
commit85e1a38692c3833c2a99540793bcc81fb9820617 (patch)
tree7e843a3bc5fabc39d0c2249fdceac20f2330a4b3 /README.org
parent0e7d98e4aa699e5e92de0864b0eb57a2d787c8c7 (diff)
downloadguix-forge-85e1a38692c3833c2a99540793bcc81fb9820617.tar.gz
guix-forge-85e1a38692c3833c2a99540793bcc81fb9820617.tar.lz
guix-forge-85e1a38692c3833c2a99540793bcc81fb9820617.zip
doc: List software components used by guix-forge.
* README.org, doc/forge.skb (Introduction): List software components used by guix-forge.
Diffstat (limited to 'README.org')
-rw-r--r--README.org9
1 files changed, 9 insertions, 0 deletions
diff --git a/README.org b/README.org
index 1197593..855ebdd 100644
--- a/README.org
+++ b/README.org
@@ -2,6 +2,15 @@
/guix-forge/ is a Guix service that lets you run a complete [[https://en.wikipedia.org/wiki/Forge_(software)][software forge]] in the manner of GitHub, GitLab, etc. Unlike other free software forges such as GitLab, Gitea, etc., /guix-forge/ is not a monolith but is an assemblage of several pieces of server software wired up to function as one. In this sense, it is a /meta-service/. /guix-forge/ does for software forges what [[https://mailinabox.email/][Mail-in-a-Box]] does for email.
+/guix-forge/ integrates the following software components:
+
+- [X] laminar for continuous integration
+- [ ] web server to serve static project sites
+- [ ] cgit to serve project git repositories on the web
+- [ ] public-inbox for project discussions
+
+A choice of different software components may be offered provided it does not complicate the interface too much.
+
/guix-forge/ is provided on a best effort basis. Its design is unstable, and open to change. We will try our best to not break your system configuration often, but it might happen.
* Installation