Skip to content

Commit

Permalink
Changed package name
Browse files Browse the repository at this point in the history
  • Loading branch information
Janos Pasztor committed Dec 24, 2020
1 parent bd12484 commit 7d6e76d
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 0 deletions.
2 changes: 2 additions & 0 deletions .goreleaser.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,11 @@ nfpms:
maintainer: Janos Pasztor <[email protected]>
description: The guest agent for ContainerSSH, an SSH server that launches containers on demand.
license: MIT
package_name: containerssh-agent
builds:
- containerssh-agent
formats:
- apk
- deb
- rpm
bindir: /usr/bin
Expand Down
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,22 @@ This is the agent meant to be installed in the containers run by ContainerSSH. W

<p align="center"><strong>Note: This is a developer documentation.</strong><br />The user documentation for ContainerSSH is located at <a href="https://containerssh.github.io">containerssh.io</a>.</p>

## Integrating the agent

This agent is intended to be integrated into container images. The installation process is as follows:

1. Go to the [releases section](https://github.com/ContainerSSH/agent/releases).
2. Download the latest release for your platform, as well as the signature file.
3. Download the GPG key from [https://containerssh.io/gpg.txt](https://containerssh.io/gpg.txt).
4. Import the GPG key into your keychain (`gpg --import gpg.txt`).
5. Edit the key: `gpg --edit-key 3EE5B012FA7B400CD952601E4689F1F0F358FABA`
6. Mark it as trusted: `trust`
7. Quit using the `quit` command.
8. Verify the GPG signature: `gpg --verify downloadedfile.sig downloadedfile`
9. Install the file using your package manager.

You can look at the default [guest image Dockerfile](https://github.com/containerssh/guest-image) for an example on Ubuntu.

## How this application works

This application is intended as a single binary to be embedded into a container image to handle features that the container engine (Docker, Kubernetes) does not support. Currently, the following modes are supported:
Expand Down

0 comments on commit 7d6e76d

Please sign in to comment.