aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--README.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/README.md b/README.md
index 848a46e..a543923 100644
--- a/README.md
+++ b/README.md
@@ -90,14 +90,37 @@ basepath: ./repos
repos:
- name: myrepo
public: false
+ go_module: false # Git-only repository
permissions:
- role: maintainers
mode: 1
git_web_config:
owner: username
description: Repository description
+- name: mylib
+ public: true
+ go_module: true # Enable Go module proxy for this repo
+ permissions:
+ - role: admin
+ mode: 1
+ - role: maintainers
+ mode: 1
```
+**Repository Configuration Options:**
+
+- `go_module: true` - Enables Go module proxy endpoints for `go get` compatibility
+ - Serves go-import meta tags for module discovery
+ - Provides module proxy endpoints (@v/list, @latest, .info, .mod, .zip)
+ - Generates version metadata from git tags
+- `go_module: false` - Standard Git repository (default)
+- `public: true` - Repository accessible without authentication for read operations
+- `public: false` - Requires authentication for all operations
+
+**Permission modes:**
+- `mode: 1` - Read/write access
+- `mode: 0` - Read-only access
+
The server will automatically use the repository directory path as the base path when using the default configuration if the management repository is not found.
### Authentication Model (auth_model.ini)