From 8bb2be5a99bae8b274c403afcf0cfa270cde25ce Mon Sep 17 00:00:00 2001 From: flu0r1ne Date: Tue, 20 Jul 2021 17:08:54 -0500 Subject: cGit behind NGINX on Ubuntu -- Post --- pages/posts/cgit-nginx-ubuntu/cgit-nginx-ubuntu.md | 96 ++++++++ pages/posts/cgit-nginx-ubuntu/index.tsx | 12 + pages/posts/index.tsx | 2 - pages/posts/nebula-on-debian/index.tsx | 12 - pages/posts/nebula-on-debian/nebula.md | 256 -------------------- pages/posts/packaging-nebula-for-debian/index.tsx | 12 + pages/posts/packaging-nebula-for-debian/nebula.md | 263 +++++++++++++++++++++ pages/posts/posts.md | 3 +- 8 files changed, 385 insertions(+), 271 deletions(-) create mode 100644 pages/posts/cgit-nginx-ubuntu/cgit-nginx-ubuntu.md create mode 100644 pages/posts/cgit-nginx-ubuntu/index.tsx delete mode 100644 pages/posts/nebula-on-debian/index.tsx delete mode 100644 pages/posts/nebula-on-debian/nebula.md create mode 100644 pages/posts/packaging-nebula-for-debian/index.tsx create mode 100644 pages/posts/packaging-nebula-for-debian/nebula.md (limited to 'pages/posts') diff --git a/pages/posts/cgit-nginx-ubuntu/cgit-nginx-ubuntu.md b/pages/posts/cgit-nginx-ubuntu/cgit-nginx-ubuntu.md new file mode 100644 index 0000000..c225bd4 --- /dev/null +++ b/pages/posts/cgit-nginx-ubuntu/cgit-nginx-ubuntu.md @@ -0,0 +1,96 @@ +Installing cGit behind NGINX on Ubuntu +====================================== + +[cGit](https://git.zx2c4.com/cgit/about/) is a fast web interface based on the CGI specification. It is lightweight and doesn't require a database or web authentication system. + +It's easy to configure. For some reason, all the online guides for Ubuntu decided they needed to compile it from scratch and write their own start scripts in a mix of perl and bash. You don't need superhero sysadmin skills from the late 90s. All components are packaged with systemd units... there is a better way... + +### 1. Install `cgit` and `fcgiwrap`. + +`fcgiwrap` will create a socket NGINX can use to pass the CGI variables to cGit: +``` +sudo apt install fcgiwrap +sudo apt install cgit +``` + +### 2. Modify the `cgitrc` file under `/etc/cgitrc` to your liking: +``` +# See cgitrc(5) +# prepend this string to every url +virtual-root=/ +enable-index-links=1 +enable-commit-graph=1 + +root-title=My Git Repos +root-desc=I exclusivly write code in Smalltalk-71 +logo=/assets/my_custom_logo.png + +# Add site-specific configuration +# ... + +``` + +### 3. Optionally create an assets directory and add your custom logo / css: +``` +mkdir /var/www/html/assets +cp my_custom_logo.png /var/www/html/assets +``` + +### 4. Configure NGINX + +Add the site to NGINX. This launches the `cgit.cgi` executable passing it to the `fcgiwrap` socket: +```conf +echo >/etc/nginx/sites-available/cgit.conf < + ); +} \ No newline at end of file diff --git a/pages/posts/index.tsx b/pages/posts/index.tsx index 9cbc4bc..e139ef5 100644 --- a/pages/posts/index.tsx +++ b/pages/posts/index.tsx @@ -1,5 +1,3 @@ -import { Breadcrumbs, LinkCrumb } from '../../components/Breadcrumbs'; -import Link from 'next/link'; import DefaultPage from '../../templates/Default'; import Markdown from '../../components/Markdown'; //@ts-ignore diff --git a/pages/posts/nebula-on-debian/index.tsx b/pages/posts/nebula-on-debian/index.tsx deleted file mode 100644 index 9d3741d..0000000 --- a/pages/posts/nebula-on-debian/index.tsx +++ /dev/null @@ -1,12 +0,0 @@ -// @ts-ignore -import md from './nebula.md'; -import MarkdownPage from '../../../templates/MarkdownPage'; - -export default function NebulaOnDebian() { - return ( - - ); -} \ No newline at end of file diff --git a/pages/posts/nebula-on-debian/nebula.md b/pages/posts/nebula-on-debian/nebula.md deleted file mode 100644 index 9f62040..0000000 --- a/pages/posts/nebula-on-debian/nebula.md +++ /dev/null @@ -1,256 +0,0 @@ -Nebula on Debian -================= - -> **Created:** 2021-07-18 **Last Updated:** 2021-07-19 - -I am close to concluding a multi-week endevor to package [Nebula](https://github.com/slackhq/nebula), a VPN-style network mesh networking overlay. If all goes well, it will be uploaded to `debian/unstable` within the next few days. This would also mean the package would be pulled into Ubuntu during the next merge window. - -Preemptively, I'm going to write up a set of install instructions specific to debian derivatives and briefly a few of the decisions made during the packaging process. - -Installation ------------- - -**Step one will currently fail. See [installing from unstable](#installing-from-unstable)** - -For the sake of simplicity, I'm going to assume that you're setting up a network with two nodes -- one lighthouse node and a node on your laptop. Once you understand the process, it easily scales to as many nodes as you wish. Pick your favorite virtualization provider in order to set up the lighthouse. The lighthouse requires minimal resources because it functions as a mutually-reachable node which synchronizes the address mappings. You could use a home server provided that you have a static ip (unlikely) or setup dynamic DNS. The latter may introduce some instability. I'm also assuming both clients are debian derivatives and have access to `apt`. - -If this is not the case, please consult the [upstream instructions](https://github.com/slackhq/nebula#user-content-getting-started-quickly) which will guide you through the processing of installing the binaries directly. - -#### 1. Install Nebula through Aptitude - -You'll need to install Nebula on both endpoints. - -```bash -sudo apt install nebula -``` - -#### 2. Creating a certificate authority - -The certificate authority is to "root of trust" for a Nebula network. Compromising the certificate authority's key file would compromise the integrity and security of the entire network. The upstream instructions recommend that you store the key file in a location with strong encryption [^1]. - -You can generate a `ca.key` and `ca.cert` file with the following command: -```bash -nebula-cert ca -name "Myorganization, Inc" -``` - -You will copy the `ca.crt` file to all the hosts. The `ca.key` file should remain secret. - -#### 4. Nebula host keys and certificates generated from that certificate authority - -With your `ca.key` file in hand, generate keys for each node. - -```bash -nebula-cert sign -name "lighthouse" -ip "192.168.100.1/24" -nebula-cert sign -name "laptop" -ip "192.168.100.2/24" -``` - -Repeate this process for each node. It is important that each is issued a unique internal ip. The IPs are specified in CIDR notation [^2]. This internal ip will be used to configure Nebula later. - -#### 4. Copy the configuration files to each host - -Each host requires the `host.key`, `host.crt`, and `ca.crt` files to be present on the system. By convention, these are located in the `/etc/nebula` directory. Make sure to copy them into this directory. - -For example, to copy the credentials to a lighthouse with ip `203.0.113.11` as `user` you may use sftp and ssh as follows: - -```bash -sftp user@203.0.113.11 </etc/apt/sources.list.d/99-tmp-nebula-overrides.list </etc/apt/preferences.d/99-tmp-nebula-prefer-stable < + ); +} \ No newline at end of file diff --git a/pages/posts/packaging-nebula-for-debian/nebula.md b/pages/posts/packaging-nebula-for-debian/nebula.md new file mode 100644 index 0000000..d1c178f --- /dev/null +++ b/pages/posts/packaging-nebula-for-debian/nebula.md @@ -0,0 +1,263 @@ +Packaging Nebula for Debian +================= + +> **Created:** 2021-07-18 **Last Updated:** 2021-07-19 + +I am close to concluding a multi-week endevor to package [Nebula](https://github.com/slackhq/nebula), a VPN-style network mesh networking overlay. If all goes well, it will be uploaded to `debian/experimental` within the next few days. This would also mean the package would be pulled into Ubuntu during the next merge window. + +### Timeline + +Unfortunately, Debian does not adhere to a constant release cycle. This means the timeline is uncertain. It will likely be uploaded to `experimental` within a few days. [See the new queue.](https://ftp-master.debian.org/new.html) It will stay in experimental for the next three months or so until the next release occurs. (It is incompatible with the version of protobuf in unstable. This prevents it from moving into unstable until the next version release.) +``` +{upload queue} -> [experimental] -> [unstable (sid)] -> [testing] -> [next release] +``` + +Preemptively, I'm going to write up a set of install instructions specific to debian derivatives and briefly a few of the decisions made during the packaging process. + +Installation +------------ + +**Step one will currently fail. See [installing from experimental](#installing-from-experimental)** + +For the sake of simplicity, I'm going to assume that you're setting up a network with two nodes -- one lighthouse node and a node on your laptop. Once you understand the process, it easily scales to as many nodes as you wish. Pick your favorite virtualization provider in order to set up the lighthouse. The lighthouse requires minimal resources because it functions as a mutually-reachable node which synchronizes the address mappings. You could use a home server provided that you have a static ip (unlikely) or setup dynamic DNS. The latter may introduce some instability. I'm also assuming both clients are debian derivatives and have access to `apt`. + +If this is not the case, please consult the [upstream instructions](https://github.com/slackhq/nebula#user-content-getting-started-quickly) which will guide you through the processing of installing the binaries directly. + +#### 1. Install Nebula through Aptitude + +You'll need to install Nebula on both endpoints. + +```bash +sudo apt install nebula +``` + +#### 2. Creating a certificate authority + +The certificate authority is to "root of trust" for a Nebula network. Compromising the certificate authority's key file would compromise the integrity and security of the entire network. The upstream instructions recommend that you store the key file in a location with strong encryption [^1]. + +You can generate a `ca.key` and `ca.cert` file with the following command: +```bash +nebula-cert ca -name "Myorganization, Inc" +``` + +You will copy the `ca.crt` file to all the hosts. The `ca.key` file should remain secret. + +#### 4. Nebula host keys and certificates generated from that certificate authority + +With your `ca.key` file in hand, generate keys for each node. + +```bash +nebula-cert sign -name "lighthouse" -ip "192.168.100.1/24" +nebula-cert sign -name "laptop" -ip "192.168.100.2/24" +``` + +Repeate this process for each node. It is important that each is issued a unique internal ip. The IPs are specified in CIDR notation [^2]. This internal ip will be used to configure Nebula later. + +#### 4. Copy the configuration files to each host + +Each host requires the `host.key`, `host.crt`, and `ca.crt` files to be present on the system. By convention, these are located in the `/etc/nebula` directory. Make sure to copy them into this directory. + +For example, to copy the credentials to a lighthouse with ip `203.0.113.11` as `user` you may use sftp and ssh as follows: + +```bash +sftp user@203.0.113.11 </etc/apt/sources.list.d/99-tmp-nebula-overrides.list </etc/apt/preferences.d/99-tmp-nebula-prefer-stable <