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.

Point the install instructions at rodent.software

c1edfd3c7d2d54c14e2b94405ca02232ba8e27da · Keenan Nemetz · 3d ago · parent 942c93cd

Point the install instructions at rodent.software

Vole's releases are now published on its own instance, so the guides name
that host instead of the placeholder: the .deb URL in each guide, the curl
in the manual install, and the release page where a reader finds both.

The example instance host stays forge.example.com, and stays distinct from
the host the package comes from. It stands for the reader's machine; calling
it rodent.software would invite someone to deploy their own forge under
someone else's name.

The sample in check-deploy.py moves with the guides, so the rendered user
data it checks carries a URL with the shape a real one has.

docs/deploy/vps.md +3−3

@@ -24,7 +24,7 @@ HOSTNAME=forge.example.com \
	24	24	ADMIN_ACCOUNT=admin \
	25	25	ADMIN_EMAIL=you@example.com \
	26	26	ADMIN_SSH_KEY="$(cat ~/.ssh/id_ed25519.pub)" \
	27		VOLE_PACKAGE_URL=https://example.com/r/vole/releases/v0.2.0/artifacts/vole_0.2.0-1_amd64.deb \
		27	VOLE_PACKAGE_URL=https://rodent.software/r/vole/releases/v0.2.0/artifacts/vole_0.2.0-1_amd64.deb \
	28	28	./render.sh > user-data.yaml
	29	29	```
	30	30
@@ -36,7 +36,7 @@ machine. The values are:
	36	36	\| `HOSTNAME` \| The name people will reach the forge on. It becomes `public_url`, and passkeys bind to it, so choose the one you intend to keep \|
	37	37	\| `ADMIN_ACCOUNT` \| Name of the first account, made an instance admin. Account names are permanent \|
	38	38	\| `ADMIN_SSH_KEY` \| Public key of that account, as in the contents of `~/.ssh/id_ed25519.pub` \|
	39		\| `VOLE_PACKAGE_URL` \| The `.deb` for the machine's architecture \|
		39	\| `VOLE_PACKAGE_URL` \| The `.deb` for the machine's architecture, from [Vole's releases](https://rodent.software/r/vole/releases) \|
	40	40	\| `ADMIN_EMAIL` \| Contact address for the certificate authority. Optional, but a good idea \|
	41	41	\| `INSTANCE_NAME` \| What the landing page calls this forge. Default `Vole` \|
	42	42	\| `TLS_MODE` \| `acme` (the default) lets Vole obtain its own certificate. `proxy` leaves TLS to a proxy you run, and serves plain HTTP on loopback \|
@@ -63,7 +63,7 @@ produces, done by hand.
	63	63
	64	64	```sh
	65	65	# On the machine, as a user with sudo.
	66		curl -fsSLO https://example.com/r/vole/releases/v0.2.0/artifacts/vole_0.2.0-1_amd64.deb
		66	curl -fsSLO https://rodent.software/r/vole/releases/v0.2.0/artifacts/vole_0.2.0-1_amd64.deb
	67	67	sudo apt install ./vole_0.2.0-1_amd64.deb
	68	68	```
	69	69