Quick start
The server repository ships a docker compose stack for local evaluation and development. It starts:
| Service | URL | Credentials |
|---|---|---|
| Entrepot (UI, API, package endpoints) | http://localhost:8080 |
Keycloak users below, or the bootstrap token dev-bootstrap-token |
| Keycloak (OIDC) | http://keycloak.localhost:8081 |
admin console admin / admin; users alice / alice (in entrepot-admins) and bob / bob (in developers) |
| MinIO (S3 blob store) | http://localhost:9001 |
minioadmin / minioadmin |
| Postgres 16 | localhost:5432 |
entrepot / entrepot |
You need Docker with Compose v2. The Entrepot image is built from source the first time, so allow a few minutes.
-
Start the stack
Terminal window git clone https://github.com/entrepotproj/entrepot.gitcd entrepotdocker compose -f deploy/compose/docker-compose.yaml up -d --buildWait until
docker compose -f deploy/compose/docker-compose.yaml psshows theentrepotcontainer running, then check it is ready:Terminal window curl -fsS http://localhost:8080/readyz # → ready -
Sign in
Open
http://localhost:8080and choose Sign in with Keycloak. Log in asalice/alice: she is in theentrepot-adminsgroup, which the compose configuration (auth.adminGroups) makes a system administrator.bob/bobis an ordinary user in thedevelopersgroup. -
Create some repositories
The stack has two blob stores:
default(a local volume) andminio(an S3 bucket in MinIO). Create a proxy for each public registry and a hosted repository for your own files with the bootstrap token:Terminal window E=http://localhost:8080; T=dev-bootstrap-tokenapi() { curl -fsS -H "Authorization: Bearer $T" -H 'Content-Type: application/json' "$@"; }api -X POST $E/api/v1/repositories -d '{"name":"npm-proxy","format":"npm","kind":"proxy","blobStore":"default","anonymousRead":true,"proxy":{"remoteUrl":"https://registry.npmjs.org"}}'api -X POST $E/api/v1/repositories -d '{"name":"pypi-proxy","format":"pypi","kind":"proxy","blobStore":"default","anonymousRead":true,"proxy":{"remoteUrl":"https://pypi.org"}}'api -X POST $E/api/v1/repositories -d '{"name":"docker-hub","format":"docker","kind":"proxy","blobStore":"minio","anonymousRead":true,"proxy":{"remoteUrl":"https://registry-1.docker.io"}}'api -X POST $E/api/v1/repositories -d '{"name":"files","format":"raw","kind":"hosted","blobStore":"default"}'You can do the same in the UI under Repositories → Create repository.
-
Use them
Terminal window pip install --index-url http://localhost:8080/repository/pypi-proxy/simple/ requestsTerminal window npm install --registry http://localhost:8080/repository/npm-proxy/ lodashTerminal window # plain HTTP: add "localhost:8080" to insecure-registries if your Docker# daemon does not already treat localhost as insecuredocker pull localhost:8080/docker-hub/library/alpine:3.20Terminal window echo hello > hello.txtcurl -fsS -H "Authorization: Bearer dev-bootstrap-token" -T hello.txt \http://localhost:8080/repository/files/demo/hello.txtcurl -fsS -u token:dev-bootstrap-token http://localhost:8080/repository/files/demo/hello.txtThe first request fetches from the upstream and stores the content in the repository’s blob store; repeat requests are served from the cache. Browse the cached components in the UI.
-
Create a personal token
In the UI, open API tokens → Create token. Use it as
$ENTREPOT_TOKENin the rest of the docs — it is shown only once.
Explore
Section titled “Explore”- Swagger UI at
http://localhost:8080/api/docs, or this site’s API reference. - Who am I?
curl -H "Authorization: Bearer $ENTREPOT_TOKEN" http://localhost:8080/api/v1/me - GitLab CI: to try
id_tokenauthentication against a GitLab instance, uncomment theauth.gitlabblock indeploy/compose/entrepot.yamland restart theentrepotservice. See GitLab CI.
Clean up
Section titled “Clean up”docker compose -f deploy/compose/docker-compose.yaml down -v # -v also deletes the data volumesNext steps
Section titled “Next steps”- Create your first repositories — proxies, a hosted repository and a group.
- Learn the concepts — repository kinds, components and assets, blob stores and permissions.