aboutsummaryrefslogtreecommitdiff
path: root/doc/book/connect/repositories.md
diff options
context:
space:
mode:
authorQuentin Dufour <quentin@deuxfleurs.fr>2022-02-01 17:39:35 +0100
committerAlex Auvolat <alex@adnab.me>2022-02-07 16:01:45 +0100
commit5a1fb7cce732a5eaffa4d5683cfabcd2d0d6dd7d (patch)
tree99cdc7d40916cf15e6409b1e3edfa0dd92a1e7f4 /doc/book/connect/repositories.md
parent1c0ba930b8d6aa5d97e6942852240861e6ab9bed (diff)
downloadgarage-5a1fb7cce732a5eaffa4d5683cfabcd2d0d6dd7d.tar.gz
garage-5a1fb7cce732a5eaffa4d5683cfabcd2d0d6dd7d.zip
Improve integration part of the doc
Diffstat (limited to 'doc/book/connect/repositories.md')
-rw-r--r--doc/book/connect/repositories.md51
1 files changed, 45 insertions, 6 deletions
diff --git a/doc/book/connect/repositories.md b/doc/book/connect/repositories.md
index eb06e360..696ef9a4 100644
--- a/doc/book/connect/repositories.md
+++ b/doc/book/connect/repositories.md
@@ -6,6 +6,15 @@ weight = 15
Whether you need to store and serve binary packages or source code, you may want to deploy a tool referred as a repository or registry.
Garage can also help you serve this content.
+| Name | Status | Note |
+|------|--------|------|
+| [Gitea](#gitea) | ✅ | |
+| [Docker](#generic-static-site-generator) | ✅ | Requires garage >= v0.6.0 |
+| [Nix](#generic-static-site-generator) | ✅ | |
+| [Gitlab](#gitlab) | ❓ | Not yet tested |
+
+
+
## Gitea
You can use Garage with Gitea to store your [git LFS](https://git-lfs.github.com/) data, your users' avatar, and their attachements.
@@ -55,18 +64,42 @@ $ aws s3 ls s3://gitea/avatars/
*External link:* [Gitea Documentation > Configuration Cheat Sheet](https://docs.gitea.io/en-us/config-cheat-sheet/)
-## Gitlab
+## Docker
-*External link:* [Gitlab Documentation > Object storage](https://docs.gitlab.com/ee/administration/object_storage.html)
+Create a bucket and a key for your docker registry, then create `config.yml` with the following content:
+
+```yml
+version: 0.1
+http:
+ addr: 0.0.0.0:5000
+ secret: asecretforlocaldevelopment
+ debug:
+ addr: localhost:5001
+storage:
+ s3:
+ accesskey: GKxxxx
+ secretkey: yyyyy
+ region: garage
+ regionendpoint: http://localhost:3900
+ bucket: docker
+ secure: false
+ v4auth: true
+ rootdirectory: /
+```
+Replace the `accesskey`, `secretkey`, `bucket`, `regionendpoint` and `secure` values by the one fitting your deployment.
-## Private NPM Registry (Verdacio)
+Then simply run the docker registry:
-*External link:* [Verdaccio Github Repository > aws-storage plugin](https://github.com/verdaccio/verdaccio/tree/master/packages/plugins/aws-storage)
+```bash
+docker run \
+ --net=host \
+ -v `pwd`/config.yml:/etc/docker/registry/config.yml \
+ registry:2
+```
-## Docker
+*We started a plain text registry but docker clients require encrypted registries. You must either [setup TLS](https://docs.docker.com/registry/deploying/#run-an-externally-accessible-registry) on your registry or add `--insecure-registry=localhost:5000` to your docker daemon parameters.*
-Not yet compatible, follow [#103](https://git.deuxfleurs.fr/Deuxfleurs/garage/issues/103).
*External link:* [Docker Documentation > Registry storage drivers > S3 storage driver](https://docs.docker.com/registry/storage-drivers/s3/)
@@ -170,3 +203,9 @@ on the binary cache, the client will download the result from the cache instead
Channels additionnaly serve Nix definitions, ie. a `.nix` file referencing
all the derivations you want to serve.
+
+## Gitlab
+
+*External link:* [Gitlab Documentation > Object storage](https://docs.gitlab.com/ee/administration/object_storage.html)
+
+