Getting started
Authentication
Use your Highwall account to sign in, pull packages, and publish artifacts.
Get an account
Ask a Highwall administrator to create a username and password in Users. An administrator can grant access to a repository in Permissions, either directly or through a group.
- Read allows pulling and downloading artifacts.
- Write allows publishing artifacts. Grant read and write for Docker publishing.
- Administrators already have access to all repositories.
Sign in to the app
Open the Highwall app and enter your username and password. In local development, automatic browser sign-in may be enabled. Docker clients still need a username and password.
Authenticate API requests
Use HTTP Basic authentication with your account. This command prompts for your password:
curl --fail-with-body --user your-username \
https://highwall.example/api/v1/security/whoami
For scripts, create an access token in Tokens. Copy the secret when it is shown, and send it as a bearer token. Tokens inherit your account's permissions and can be revoked from the same page.
curl --fail-with-body --header "Authorization: Bearer $HIGHWALL_TOKEN" \
https://highwall.example/api/v1/security/whoami
For Docker, use docker login as described in Publishing a Docker image.
Using repositories
Pulling artifacts
Download files and packages from repositories you can read.
Before you start
Find the repository key and artifact path in Browse. Your account needs read permission unless the repository allows anonymous reads.
Download a generic artifact
For a generic repository named libs-local, download releases/file.bin with:
curl --fail --location --user your-username \
--output file.bin \
https://highwall.example/libs-local/releases/file.bin
Enter your Highwall password when prompted. You can also select an artifact in Browse and use its download link.
Other package types
Maven and npm use the repository base URL, https://highwall.example/{repoKey}. PyPI uses https://highwall.example/{repoKey}/simple/. Choose a repository matching your package type and configure authentication in its package client.
To upload your own artifacts, continue to Publishing artifacts.
Pulling artifacts / Docker images
Pulling Docker images
Pull a Docker image from Highwall to your local Docker daemon.
Before you start
Install Docker and make sure its daemon is running. Find the repository key, image name, and tag in Browse. Your account needs read permission unless the repository allows anonymous reads.
1. Log in to the registry
docker login highwall.example --username your-username
Enter your Highwall password when prompted. Use only the hostname and port for login, without a URL scheme or repository path. Browser automatic sign-in does not authenticate Docker clients.
2. Pull the image
Image names follow {registry}/{repoKey}/{image}:{tag}. For an image named nginx:local-test in docker-local:
docker pull highwall.example/docker-local/nginx:local-test
Replace the repository key, image name, and tag with those of the image you want to pull.
3. Verify the image
docker image inspect highwall.example/docker-local/nginx:local-test
This displays the metadata for the downloaded image.
Troubleshooting
- Unauthorized or denied: run
docker login again and check your read permission on the repository.
- Image or tag not found: check the repository key, image name, and tag in Browse.
- Connection refused: use the server address reachable from your Docker daemon. If Highwall runs on another machine, replace
localhost with that machine's hostname or IP address.
- HTTPS client / HTTP server: for local HTTP testing, configure the registry's hostname and port in your Docker daemon's
insecure-registries list and restart Docker. Use HTTPS for a deployed registry.
To upload your own image, continue to Publishing a Docker image.
Using repositories
Publishing artifacts
Upload builds and packages to a local Highwall repository.
Prepare a repository
- Ask an administrator to create a repository in Repositories.
- Choose class local and the appropriate package type: generic, Maven, npm, PyPI, or Docker.
- Grant your account write permission in Permissions. Docker publishing also needs read permission.
Remote and virtual repositories do not accept uploads. Publish to a local repository.
Upload a generic artifact
For a local generic repository named libs-local:
curl --fail-with-body --user your-username \
--upload-file ./file.bin \
https://highwall.example/libs-local/releases/file.bin
Enter your Highwall password when prompted. Uploading to an existing generic artifact path replaces the content at that path.
Verify the upload
Open Browse, select your repository, and locate the uploaded file. Follow Pulling artifacts to download it again.
Publish a container image
Follow Docker image for repository setup, login, build, push, and verification commands.
Publishing artifacts / Docker image
Publishing a Docker image
Build a basic nginx image and push it to Highwall using Docker.
1. Create a Docker repository
In Repositories, create docker-local with class local and package type docker, or use an existing local Docker repository. Your account needs read and write permissions on it.
2. Log in to the registry
docker login highwall.example --username your-username
Enter your Highwall password when prompted. Use only the hostname and port for login, without a URL scheme or repository path.
3. Create a Dockerfile
In an empty directory, save this as Dockerfile:
FROM nginx:alpine
COPY index.html /usr/share/nginx/html/index.html
EXPOSE 80
Save a test page as index.html beside the Dockerfile:
<!doctype html>
<html lang="en">
<meta charset="utf-8">
<title>Highwall nginx test</title>
<h1>Hello from Highwall!</h1>
</html>
4. Build and push
Run these commands from the directory containing both files:
docker build --tag highwall.example/docker-local/nginx:local-test .
docker push highwall.example/docker-local/nginx:local-test
The image name follows {registry}/{repoKey}/{image}:{tag}. Replace docker-local if you chose a different repository key.
5. Pull and run
On a machine with Docker, pull the image and run the test page:
docker pull highwall.example/docker-local/nginx:local-test
docker run --rm --detach --name highwall-nginx-test \
--publish 8081:80 highwall.example/docker-local/nginx:local-test
curl --fail http://localhost:8081/
docker stop highwall-nginx-test
The response should contain Hello from Highwall!. The curl command assumes your Docker daemon runs on the same machine as your terminal.
Troubleshooting
- Unauthorized: run
docker login again with your Highwall username and password. Browser automatic sign-in does not log Docker in.
- Denied: check read and write permissions, the repository key, and that the repository is local and has package type Docker.
- HTTPS client / HTTP server: for local HTTP testing, add the registry's hostname and port to your Docker daemon's
insecure-registries list and restart Docker. Use HTTPS for a deployed registry.
- Connection refused: use an address reachable from your Docker daemon;
localhost refers to the daemon's machine.