Skip to content

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.

  1. Start the stack

    Terminal window
    git clone https://github.com/entrepotproj/entrepot.git
    cd entrepot
    docker compose -f deploy/compose/docker-compose.yaml up -d --build

    Wait until docker compose -f deploy/compose/docker-compose.yaml ps shows the entrepot container running, then check it is ready:

    Terminal window
    curl -fsS http://localhost:8080/readyz # → ready
  2. Sign in

    Open http://localhost:8080 and choose Sign in with Keycloak. Log in as alice / alice: she is in the entrepot-admins group, which the compose configuration (auth.adminGroups) makes a system administrator. bob / bob is an ordinary user in the developers group.

  3. Create some repositories

    The stack has two blob stores: default (a local volume) and minio (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-token
    api() { 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.

  4. Use them

    Terminal window
    pip install --index-url http://localhost:8080/repository/pypi-proxy/simple/ requests

    The 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.

  5. Create a personal token

    In the UI, open API tokens → Create token. Use it as $ENTREPOT_TOKEN in the rest of the docs — it is shown only once.

  • 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_token authentication against a GitLab instance, uncomment the auth.gitlab block in deploy/compose/entrepot.yaml and restart the entrepot service. See GitLab CI.
Terminal window
docker compose -f deploy/compose/docker-compose.yaml down -v # -v also deletes the data volumes