# Self-host Kellnr

> Self-hosted registry for private Rust crates with a web UI and docs hosting. Runs a single container with data on a volume.

- Page: https://levelrail.com/templates/kellnr/
- JSON: https://levelrail.com/templates/kellnr.json
- Category: Developer Tools
- Licence: Apache-2.0 (Permissive license)
- Source: https://github.com/kellnr/kellnr
- Upstream docs: https://kellnr.io/documentation

## Requirements
- Memory: about 256 MiB
- amd64: unknown, arm64: unknown
- Needs configuration before start: no
- Pinned image tag: 7.1.0

## Services

| Service | Image | Tag | Ports | Volumes |
| --- | --- | --- | --- | --- |
| kellnr | ghcr.io/kellnr/kellnr | 7.1.0 | 8000 | kdata -> /opt/kdata |

## Environment

| Service | Variable | Kind |
| --- | --- | --- |
| kellnr | KELLNR_ORIGIN__HOSTNAME | preset |
| kellnr | KELLNR_REGISTRY__DATA_DIR | preset |

## Deploy

### CLI

```bash
levelrail-cli templates install kellnr --name my-kellnr
```

Add --domain SERVICE=HOST to serve a service on your own domain, for example --domain kellnr=app.example.com.

### API

```bash
curl -X POST -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" \
  https://levelrail.example.com/api/v1/service-templates/kellnr/install \
  -d '{
    "name": "my-kellnr"
  }'
```

Create a token in the dashboard first. Name, env and domains are the request fields.

## First run
1. Sign in as admin with the password admin and change it at once, because it is public knowledge. Set the hostname setting to the address you serve it on.

## Questions

### Can I deploy Kellnr on Dokploy or Dokku?

The services and pinned images on this page can be run on any Docker host. The public Dokploy templates list we compared does not have an entry with the same id for Kellnr, so on Dokploy you would use a Docker Compose application with the file from this page. Dokku deploys container images with its own commands, so the pinned image ghcr.io/kellnr/kellnr:7.1.0 is what you deploy there.

Self-host Kellnr, Kellnr docker compose file, deploy Kellnr on a VPS: this page lists the pinned image, ports, volumes and the commands for each.
