Skip to content

Commit

Permalink
Update readme files
Browse files Browse the repository at this point in the history
  • Loading branch information
scottgigawatt committed Aug 8, 2024
1 parent 69fc776 commit 3b00149
Show file tree
Hide file tree
Showing 3 changed files with 42 additions and 5 deletions.
2 changes: 1 addition & 1 deletion .secrets.baseline
Original file line number Diff line number Diff line change
Expand Up @@ -138,5 +138,5 @@
}
]
},
"generated_at": "2024-06-29T01:00:17Z"
"generated_at": "2024-08-08T21:35:29Z"
}
10 changes: 9 additions & 1 deletion .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -1,10 +1,18 @@
{
"cSpell.words": [
"buildin",
"copyin",
"creatin",
"creds",
"generatin",
"gitleaks",
"Gluetun",
"linebreak",
"Navigatin",
"Privateerr",
"scottgigawatt",
"Sonoma"
"Sonoma",
"updatin",
"Usin"
]
}
35 changes: 32 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,21 @@

Ahoy there! Welcome to Privateerr, where we sail the digital seas with Private Internet Access and WireGuard!

Here's the updated GitHub README overview section:

## Overview 🦜⚓️

Privateerr be a Docker Compose configuration for buildin' Private Internet Access manual connection scripts into a Docker image with the required WireGuard tools. It also be generatin' a configuration file for native WireGuard connections. Hoist the sails and set yer course for secure VPN connections, me hearties!

This repo includes the [PIA manual-connections](https://github.com/pia-foss/manual-connections) repository as a submodule at [`docker/pia`](./docker/pia), so it be included in the image build.
The main Docker Compose configuration can be found in the [docker-compose.yml](./docker-compose.yml) file in the root of the repository. This file contains all the details needed to build an image that includes the necessary WireGuard tools to use the PIA manual connection scripts for creatin' a WireGuard configuration.

Ye can customize the Docker Compose setup by updatin' the `.env` file. Start by copyin' the [example.env](./example.env) file to `.env` in the root of the repo and adjust the settings to yer needs.

The current image build is based off of Ubuntu Focal, and the Dockerfile can be found at [docker/Dockerfile](./docker/Dockerfile).

Ye can use the output WireGuard configuration file to configure a VPN client like Gluetun for secure connections.
This repo includes the [PIA manual-connections](https://github.com/pia-foss/manual-connections) repository as a submodule at `docker/pia`, so it be included in the image build.

Ye can use the output WireGuard configuration file at [`config/wg0.conf`](config/wg0.conf) to configure a VPN client like Gluetun for secure connections.

## Usage 🗺️🔧

Expand All @@ -30,9 +38,30 @@ make

The treasure map to yer WireGuard configuration file will be buried in the [`config`](./config/) directory. This directory contains a default configuration file, [`wg0.conf`](./config/wg0.conf). When ye run Privateerr, this file will be updated with the PIA WireGuard configuration. Ye can then use this configuration file to configure a VPN client like Gluetun for secure connections.

## Navigatin' Troubled Waters ‍️☠️🌊

The included `Makefile` contains targets t' help ye navigate these treacherous waters. Usin' these commands will provide ye with a clearer view o' the environment an' configuration details without the additional comments. Set sail with confidence, ye scurvy dogs! 🏴‍☠️

```sh
❯ make help
Usage: make [TARGET]

Targets:
all - Builds and starts the service stack.
build-depends - Ensures build dependencies are installed.
pia-creds - Ensures Private Internet Access credentials are set.
down - Stops and removes containers, networks, volumes, and images.
clean - Alias for down.
build - Builds the service stack.
up - Builds, (re)creates, and starts containers for services.
run - Alias for up.
logs - Shows logs for the service.
help - Displays this help message.
```

## Environment Details 🏝️🔍

Privateerr has been tested on Synology DS916+ running DSM 7.2.1-69057 Update 5, with Docker Compose version v2.9.0-6413-g38f6acd as well as macOS Sonoma 14.5. But fear not, me hearties! It should work on other lands as well.
Privateerr has been tested on Synology DS916+ running DSM 7.2.1-69057 Update 5, with Docker Compose version v2.9.0-6413-g38f6acd as well as macOS Sonoma 14.6. But fear not, me hearties! It should work on other lands as well.

## License ⚖️📜

Expand Down

0 comments on commit 3b00149

Please sign in to comment.