vole
Clone
Read only, no credentials:
https://rodent.software/git/vole.git
Write over SSH with a registered key:
git clone ssh://git@0.0.0.0:2222/vole.git
A free and open-source forge that lives in your Git repo.
Unify terminology across the web UI and docs
ab326d3ac1fd947a9df45f31f6dc10ab38627882 · Keenan Nemetz · 14d ago · parent 5b814e99
Unify terminology across the web UI and docs Use account, repository, change request, enrollment link, instance admin, and sign in/out consistently. Rename the access guide to accounts-and-access.md, update its links, and record the canonical terms and retained command/URL spellings in the documentation index.
README.md +9−9
| @@ -1,6 +1,6 @@ | |||
| 1 | 1 | # Vole | |
| 2 | 2 | ||
| 3 | **A small but mighty software forge that lives in your Git repo.** | ||
| 3 | **A small but mighty software forge that lives in your Git repository.** | ||
| 4 | 4 | ||
| 5 | 5 | Vole is for developers who value ownership, simplicity, and resilience over feature | |
| 6 | 6 | count. Code, issues, change requests, approvals, releases, and CI records live in | |
| @@ -9,9 +9,9 @@ you do not own. | |||
| 9 | 9 | ||
| 10 | 10 | ## Why Vole | |
| 11 | 11 | ||
| 12 | - **Your project survives outages.** Issues, reviews, approvals, releases, and | ||
| 13 | build records clone with the code, so they are not trapped in a vendor's | ||
| 14 | database. When a hosting service goes down, your project does not. | ||
| 12 | - **Your repository survives outages.** Issues, reviews, approvals, releases, | ||
| 13 | and build records clone with the code, so they are not trapped in a vendor's | ||
| 14 | database. When a hosting service goes down, your repository does not. | ||
| 15 | 15 | - **CI is not tied to a vendor.** Add a workflow, start a runner anywhere it can run | |
| 16 | 16 | an OCI runtime (Docker, rootless Podman, or nerdctl), and Vole sends it work over | |
| 17 | 17 | SSH. Your build machines can be a server, a spare desktop, or a box in the closet. | |
| @@ -20,7 +20,7 @@ you do not own. | |||
| 20 | 20 | not need a proxy in front of it. You do not need a cloud account to get started. | |
| 21 | 21 | - **Browser sign-in without passwords.** People who file issues can enroll a | |
| 22 | 22 | passkey from a one-time link; there is no password database to protect. | |
| 23 | - **Admins can work from anywhere.** Instance admins can create users, | ||
| 23 | - **Admins can work from anywhere.** Instance admins can create accounts, | ||
| 24 | 24 | repositories, and access rules over the same SSH connection, from any machine. | |
| 25 | 25 | - **It is small on purpose.** Fewer moving parts, fewer things to break, and a | |
| 26 | 26 | codebase you can read. Vole focuses on the work most teams actually do. | |
| @@ -41,7 +41,7 @@ go build -o vole ./cmd/vole | |||
| 41 | 41 | ./vole admin init --dir . # create config and data/users.db | |
| 42 | 42 | ./vole admin user create you --key ~/.ssh/id_ed25519.pub | |
| 43 | 43 | ./vole admin repo create demo --owner you | |
| 44 | ./vole admin acl default demo read # publish: the repo is private until you do this | ||
| 44 | ./vole admin acl default demo read # publish: the repository is private until you do this | ||
| 45 | 45 | ./vole serve # SSH :2222, web :8080 | |
| 46 | 46 | ``` | |
| 47 | 47 | ||
| @@ -52,7 +52,7 @@ git clone ssh://git@127.0.0.1:2222/demo.git # read/write, key required | |||
| 52 | 52 | git clone http://127.0.0.1:8080/git/demo.git # read only, no credentials | |
| 53 | 53 | ``` | |
| 54 | 54 | ||
| 55 | To let people file issues and approve changes in a browser, set `public_url` to | ||
| 55 | To let people file issues and approve change requests in a browser, set `public_url` to | ||
| 56 | 56 | the instance's `https://` address. Add `https_addr` if you want Vole to obtain the | |
| 57 | 57 | certificate itself instead of running a proxy, then create an account and its | |
| 58 | 58 | enrollment link: | |
| @@ -76,9 +76,9 @@ never confirms that it is there. | |||
| 76 | 76 | |---|---| | |
| 77 | 77 | | Set up your first repository | [Getting started](docs/getting-started.md) | | |
| 78 | 78 | | Change bind addresses, limits, or proxy settings | [Configuration](docs/configuration.md) | | |
| 79 | | Add people and choose who can do what | [Users and access](docs/users-and-access.md) | | ||
| 79 | | Add accounts and choose what they can do | [Accounts and access](docs/accounts-and-access.md) | | ||
| 80 | 80 | | Keep issues with the code | [Issues](docs/issues.md) | | |
| 81 | | Review and merge changes | [Change requests](docs/change-requests.md) | | ||
| 81 | | Review and merge change requests | [Change requests](docs/change-requests.md) | | ||
| 82 | 82 | | Write CI workflows | [Workflows](docs/workflows.md) | | |
| 83 | 83 | | Look up workflow and image fields | [Workflow reference](docs/reference/workflow-reference.md) · [Image reference](docs/reference/image-reference.md) | | |
| 84 | 84 | | Run builds on your own machines | [Runners](docs/runner.md) | | |