Commit 838e96241b6bd7c1c91f36db288aad88ad4a4cb4
2021-12-14T10:44:56
readme
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68
diff --git a/AUTHORS b/AUTHORS
new file mode 100644
index 0000000..4952d07
--- /dev/null
+++ b/AUTHORS
@@ -0,0 +1 @@
+Thomas de Grivel <thoxdg@gmail.com>
diff --git a/README.md b/README.md
index cccc42f..4d336c9 100644
--- a/README.md
+++ b/README.md
@@ -1,19 +1,44 @@
-# Kmxgit
+# kmxgit
-To start your Phoenix server:
+[kmxgit](https://git.kmx.io/kmx.io/kmxgit) is a Git server written in C
+and Elixir.
- * Install dependencies with `mix deps.get`
- * Create and migrate your database with `mix ecto.setup`
- * Start Phoenix endpoint with `mix phx.server` or inside IEx with `iex -S mix phx.server`
+## Installation
+
+### git-auth installation
+
+Please see [git-auth README.md](https://git.kmx.io/kmx.io/git-auth).
+
+
+### Phoenix installation
+
+ * Clone repo with `git clone https://git.kmx.io/kmx.io/kmxgit.git`
+ * Change directory with `cd kmxgit`
+ * Install dependencies with `mix deps.get`
+ * Create and migrate your database with `mix ecto.setup`
+ * Start Phoenix endpoint with `mix phx.server` or inside IEx with `iex -S mix phx.server`
Now you can visit [`localhost:4000`](http://localhost:4000) from your browser.
-Ready to run in production? Please [check our deployment guides](https://hexdocs.pm/phoenix/deployment.html).
-## Learn more
+### Public access
+
+To setup public access repositories on HTTP or HTTPS you need to setup
+your web server to serve certain requests with
+[git-http-backend](https://git-scm.com/docs/git-http-backend).
+
+#### Nginx setup
+
+First you need to setup
+[fcgiwrap](https://www.nginx.com/resources/wiki/start/topics/examples/fcgiwrap/) to serve on `127.0.0.1:9001`.
- * Official website: https://www.phoenixframework.org/
- * Guides: https://hexdocs.pm/phoenix/overview.html
- * Docs: https://hexdocs.pm/phoenix
- * Forum: https://elixirforum.com/c/phoenix-forum
- * Source: https://github.com/phoenixframework/phoenix
+Then in your nginx server config :
+```
+location ~ ^(.*/info/refs|.*/git-upload-pack)$ {
+ fastcgi_pass 127.0.0.1:9001;
+ include fastcgi_params;
+ fastcgi_param SCRIPT_FILENAME /usr/local/libexec/git/git-http-backend;
+ fastcgi_param GIT_PROJECT_ROOT ~git;
+ fastcgi_param PATH_INFO $1;
+}
+```