@ -32,7 +32,7 @@ Within Mistborn is a panel to enable and manage these free extra services, local
- [Tor](https://www.torproject.org): The Onion Router. One tool in the arsenal of online security and privacy.
- [Tor](https://www.torproject.org): The Onion Router. One tool in the arsenal of online security and privacy.
# Installation
# Installation
Mistborn is regularly tested on Ubuntu 18.04 LTS. It has also been successfully used on Debian and Raspbian systems (though not regularly tested).
Mistborn is regularly tested on Ubuntu 18.04 LTS (DigitalOcean droplet with 2 GB RAM). It has also been successfully used on Debian Buster and Raspbian Buster systems (though not regularly tested).
Clone the git repository and run the install script:
Clone the git repository and run the install script:
@ -51,6 +51,7 @@ Running `install.sh` will do the following:
- install Cockpit
- install Cockpit
- create a `cockpit` system user
- create a `cockpit` system user
- configure unattended-upgrades
- configure unattended-upgrades
- create and populate traefik.toml
- create `/opt/mistborn_volumes` and setup folders for services that will be mounted within
- create `/opt/mistborn_volumes` and setup folders for services that will be mounted within
- backup original contents of `/opt/mistborn_volumes` in `/opt/mistborn_backup`
- backup original contents of `/opt/mistborn_volumes` in `/opt/mistborn_backup`
- Pull docker images for base.yml
- Pull docker images for base.yml
@ -105,6 +106,7 @@ Endpoint = <Mistborn public IP address>:39207
- Run `sudo systemctl enable wg-quick@wg_admin`
- Run `sudo systemctl enable wg-quick@wg_admin`
- Open your browser and go to "http://home.mistborn"
- Open your browser and go to "http://home.mistborn"
- Browse your Mistborn system!
- Browse your Mistborn system!
**Note:** The home.mistborn server takes a minute to come up after Mistborn is up (collectstatic on all that frontend JavaScript and CSS)
## Wireguard Management
## Wireguard Management
Mistborn users can be added (non-privileged or superuser) and removed by superusers. Multiple Wireguard profiles can be created for each user. A non-privileged user can create profiles for themselves.
Mistborn users can be added (non-privileged or superuser) and removed by superusers. Multiple Wireguard profiles can be created for each user. A non-privileged user can create profiles for themselves.