innernet-debian/README.md

# Unofficial Innernet APT Repository

[![Update Repository](https://github.com/tommie/innernet-debian/actions/workflows/main.yml/badge.svg?event=schedule)](https://github.com/tommie/innernet-debian/actions/workflows/main.yml)

This is a Ubuntu/Debian APT repository containing `.deb` files from https://github.com/tonarino/innernet/releases.
The updates are fully reproducible through GitHub Actions.

For more information, see https://github.com/tonarino/innernet.

## Installation

### Adding the Repository

```sh
codename=$(lsb_release --codename --short)
curl -sS https://tommie.github.io/innernet-debian/repository.asc | sudo tee /etc/apt/keyrings/github-tommie-innernet.asc >/dev/null
cat >/etc/apt/sources.list.d/innernet.list <<EOF
deb [signed-by=/etc/apt/keyrings/github-tommie-innernet.asc] https://tommie.github.io/innernet-debian/debian $codename contrib
EOF
apt update
```

### Installing the Server

This is installed on the coordination server machine.
It needs to be accessible from all peers.

```shell
$ sudo apt install innernet-server
```

### Installing the Peer Client

This is installed on all peers.

```shell
$ sudo apt install innernet
```

## Compatibility

We build for

* Ubuntu 22.04 (**jammy**)
* Ubuntu 20.04 (**focal**)

on

* **amd64**, x86_64
* **armhf**, armv7 (cross-build)
* **arm64**, aarch64 (cross-build)

Additionally:

* Debian 12 (**bookworm**) is served by `jammy`.
  There is a symlink in place to allow `bookworm`, which will cause APT to warn that the codenames missmatch.
  In the end, either name works.
* Debian 11 (**bullseye**) is served by `focal`.
  There is a symlink in place to allow `bullseye`, which will cause APT to warn that the codenames missmatch.
  In the end, either name works.

The authoritative source of supported distributions and architectures is [`conf/distributions`](https://github.com/tommie/innernet-debian/blob/main/debian/conf/distributions).

## License

The repository maintenance code itself is under the MIT License.
See also [LICENSE in tonarino/innernet](https://github.com/tonarino/innernet/blob/main/LICENSE).
Adds a README, LICENSE and public key. 2021-09-11 11:31:31 +00:00			`# Unofficial Innernet APT Repository`

Adds a workflow status badge. 2023-07-30 12:31:14 +00:00			`[![Update Repository](https://github.com/tommie/innernet-debian/actions/workflows/main.yml/badge.svg?event=schedule)](https://github.com/tommie/innernet-debian/actions/workflows/main.yml)`

Adds symlink from Debian 12 (bookworm) to Ubuntu jammy. Closes #3. 2023-09-01 15:16:02 +00:00			This is a Ubuntu/Debian APT repository containing `.deb` files from https://github.com/tonarino/innernet/releases.
Updates README for new codenames. 2023-05-12 14:46:32 +00:00			`The updates are fully reproducible through GitHub Actions.`
Adds a README, LICENSE and public key. 2021-09-11 11:31:31 +00:00
			`For more information, see https://github.com/tonarino/innernet.`

			`## Installation`

			`### Adding the Repository`

Updates README for the apt-key deprecation. 2023-02-17 15:25:34 +00:00			```sh
Updates README for new codenames. 2023-05-12 14:46:32 +00:00			`codename=$(lsb_release --codename --short)`
Updates README for the apt-key deprecation. 2023-02-17 15:25:34 +00:00			`curl -sS https://tommie.github.io/innernet-debian/repository.asc \| sudo tee /etc/apt/keyrings/github-tommie-innernet.asc >/dev/null`
			`cat >/etc/apt/sources.list.d/innernet.list <<EOF`
Updates README for new codenames. 2023-05-12 14:46:32 +00:00			`deb [signed-by=/etc/apt/keyrings/github-tommie-innernet.asc] https://tommie.github.io/innernet-debian/debian $codename contrib`
Adds a README, LICENSE and public key. 2021-09-11 11:31:31 +00:00			`EOF`
Updates README for the apt-key deprecation. 2023-02-17 15:25:34 +00:00			`apt update`
Adds a README, LICENSE and public key. 2021-09-11 11:31:31 +00:00			```

			`### Installing the Server`

Updates README for new codenames. 2023-05-12 14:46:32 +00:00			`This is installed on the coordination server machine.`
			`It needs to be accessible from all peers.`
Adds a README, LICENSE and public key. 2021-09-11 11:31:31 +00:00
			```shell
Updates README for the apt-key deprecation. 2023-02-17 15:25:34 +00:00			`$ sudo apt install innernet-server`
Adds a README, LICENSE and public key. 2021-09-11 11:31:31 +00:00			```

			`### Installing the Peer Client`

			`This is installed on all peers.`

			```shell
Updates README for the apt-key deprecation. 2023-02-17 15:25:34 +00:00			`$ sudo apt install innernet`
Adds a README, LICENSE and public key. 2021-09-11 11:31:31 +00:00			```

Moves Compatibility section later. 2023-07-30 13:35:46 +00:00			`## Compatibility`

			`We build for`

			`* Ubuntu 22.04 (jammy)`
Adds symlink from Debian 12 (bookworm) to Ubuntu jammy. Closes #3. 2023-09-01 15:16:02 +00:00			`* Ubuntu 20.04 (focal)`
Moves Compatibility section later. 2023-07-30 13:35:46 +00:00
			`on`

			`* amd64, x86_64`
			`* armhf, armv7 (cross-build)`
			`* arm64, aarch64 (cross-build)`

			`Additionally:`

Adds symlink from Debian 12 (bookworm) to Ubuntu jammy. Closes #3. 2023-09-01 15:16:02 +00:00			* Debian 12 (bookworm) is served by `jammy`.
			There is a symlink in place to allow `bookworm`, which will cause APT to warn that the codenames missmatch.
			`In the end, either name works.`
Moves Compatibility section later. 2023-07-30 13:35:46 +00:00			* Debian 11 (bullseye) is served by `focal`.
			There is a symlink in place to allow `bullseye`, which will cause APT to warn that the codenames missmatch.
			`In the end, either name works.`

			The authoritative source of supported distributions and architectures is [`conf/distributions`](https://github.com/tommie/innernet-debian/blob/main/debian/conf/distributions).

Adds a README, LICENSE and public key. 2021-09-11 11:31:31 +00:00			`## License`

Updates README for new codenames. 2023-05-12 14:46:32 +00:00			`The repository maintenance code itself is under the MIT License.`
			`See also [LICENSE in tonarino/innernet](https://github.com/tonarino/innernet/blob/main/LICENSE).`