From be0a9dfcbd5ea62eca32f3cebb104ae39855a4f2 Mon Sep 17 00:00:00 2001 From: joshua Date: Fri, 29 Dec 2023 23:18:01 -0500 Subject: updated wiki on how to make server --- site/404.html | 129 ++++++- site/about/index.html | 432 +++++++++++++++++++++++ site/index.html | 143 +++++++- site/search/search_index.json | 2 +- site/server/cgit/index.html | 776 ++++++++++++++++++++++++++++++++++++++++++ site/server/ddns/index.html | 612 +++++++++++++++++++++++++++++++++ site/server/server/index.html | 726 +++++++++++++++++++++++++++++++++++++++ site/sitemap.xml | 25 ++ site/sitemap.xml.gz | Bin 127 -> 235 bytes 9 files changed, 2837 insertions(+), 8 deletions(-) create mode 100644 site/about/index.html create mode 100644 site/server/cgit/index.html create mode 100644 site/server/ddns/index.html create mode 100644 site/server/server/index.html (limited to 'site') diff --git a/site/404.html b/site/404.html index 6e0b376..adcf30e 100644 --- a/site/404.html +++ b/site/404.html @@ -186,7 +186,134 @@ - Welcome to MkDocs + Home + + + + + + + + + + + + + + + + + + + +

+ + + + + + + + + + + + Server + + + + + + +

+ + + Server + +

+ + + + + Server Setup + + + + +
+ + + + + Cgit with gitolite + + + + +
+ + + + + DDNS + + + + +

+ +

+ + + + + + + + + +

+ + + + + About diff --git a/site/about/index.html b/site/about/index.html new file mode 100644 index 0000000..6285255 --- /dev/null +++ b/site/about/index.html @@ -0,0 +1,432 @@ + + + + + + + + + + + + + + + + + + + + + + + About - Joshua's Wiki + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+ + + + Skip to content + + +

+ +

+ + + + + + +

+ + + + + + + + + + +

+ + Joshua's Wiki + +

+ + + About + + +

+ + + + + + + + + + + + + +

+ +

+ + + + + + +

+ + + +

+ + + + +

+ + + + + + + + Joshua's Wiki + + +

+ + + + + Home + + + + +
+ + + + + + + + + + + + Server + + + + + + +
+ + + Server + +
- + + + + + Server Setup + + + + +
- + + + + + Cgit with gitolite + + + + +
- + + + + + DDNS + + + + +
+
+ +
+ + + + + + + + + + + + About + + + + + +

+ + + + + + + +

+ + + + +

About this wiki

This is where I will be putting my stuff on how to configure things as well as some other personal references.

+ + + + + + + + + + + + + +

+ + + +

+ +

+ + + +

+ + + + + + + + + + \ No newline at end of file diff --git a/site/index.html b/site/index.html index de49d5d..0fb25df 100644 --- a/site/index.html +++ b/site/index.html @@ -8,9 +8,13 @@ + + + + @@ -58,7 +62,7 @@

- + Skip to content @@ -94,7 +98,7 @@

- Welcome to MkDocs + Home

@@ -200,7 +204,7 @@ - Welcome to MkDocs + Home @@ -211,7 +215,7 @@ - Welcome to MkDocs + Home @@ -258,6 +262,133 @@ + + + + + + + + + + + +

+ + + + + + + + + + + + Server + + + + + + +

+ + + Server + +

+ + + + + Server Setup + + + + +
+ + + + + Cgit with gitolite + + + + +
+ + + + + DDNS + + + + +

+ +

+ + + + + + + + + +

+ + + + + About + + + + +

+ + + @@ -317,8 +448,8 @@ -

Welcome to MkDocs

For full documentation visit mkdocs.org.

Welcome to Joshua's Wiki

This is where I will be putting my stuff on how to configure things

Commands

mkdocs new [dir-name] - Create a new project.

For full documentation visit mkdocs.org.

mkdocs new [dir-name] - Create a new project.
mkdocs serve - Start the live-reloading docs server.
mkdocs build - Build the documentation site.
mkdocs -h - Print help message and exit.

mkdocs.yml    # The configuration file.\ndocs/\n    index.md  # The documentation homepage.\n    ...       # Other markdown pages, images and other files.\n

This is where I will be putting my stuff on how to configure things

mkdocs new [dir-name] - Create a new project.
mkdocs serve - Start the live-reloading docs server.
mkdocs build - Build the documentation site.
mkdocs -h - Print help message and exit.

mkdocs.yml    # The configuration file.\ndocs/\n    index.md  # The documentation homepage.\n    ...       # Other markdown pages, images and other files.\n

This is where I will be putting my stuff on how to configure things as well as some other personal references.

Install dependencies.

# apt install cgit python-is-python3 python3-pygments python3-markdown docutils-common groff perl\n

Make a git user.

sudo adduser --system --shell /bin/bash --group --disabled-password --home /home/git git\n

Allow ssh passwordless login.

usermod -p '*' username\n

Install the gitolite package from the repository directly.

Configuration of gitolite is done by modifying $HOME/.gitolite.rc.

To work correctly with cgit, gitweb and cgit configuration options need to work with gitolite.

Change:

GIT_CONFIG_KEYS  =>  '',\n

To:

GIT_CONFIG_KEYS  =>  '.*',\n

To have permissions work correctly,

Change:

UMASK  =>  0077,\n

To:

UMASK  =>  0027,\n

In the ENABLE field, add gitweb and cgit to the list.

Detailed usage of gitolite can be found here

After cgit is configured, cgit can be told to ignore a repo with this syntax.

repo gitolite-admin\n    config cgit.ignore=1\n

This page details how to add hooks to your repositories.

Example hook that updates a website every git push. Make sure this directory is owned by git.

#!/bin/sh\nGIT_WORK_TREE=/desired/website/directory git checkout -f\n

Install the fcgiwrap package.

Create a systemd service that wraps cgit with FastCGI.

# systemctl edit --full --force cgit.service\n

[Unit]\nDescription=CGI web interface to the Git SCM\nAfter=network.target\n\n[Service]\nType=exec\nExecStart=fcgiwrap -f -p \"/usr/lib/cgit/cgit.cgi\" -s tcp:127.0.0.1:8999\n\n[Install]\nWantedBy=multi-user.target\n

# systemctl start cgit\n

Add cgit configuration to caddy.

git.joshuayun.com {\n        handle_path /cgit-css/* {\n                root * /usr/share/cgit/\n                file_server\n        }\n\n        handle {\n                reverse_proxy localhost:8999 {\n                        transport fastcgi {\n                                env DOCUMENT_ROOT /usr/lib/cgit/\n                                env SCRIPT_FILENAME /usr/lib/cgit/cgit.cgi\n                        }\n                }\n        }\n}\n

More detailed documentation can be found on the cgitrc(5) manual.

enable-git-config is used to allow for gitweb.* configurations in gitolite, e.g. description, owner.

enable-git-config=1\n

project-list sets where cgit looks for projects, this list is the one updated by gitolite

project-list=/home/git/projects.list\n

scan-path sets where the actual git repositories live

scan-path=/home/git/repositories\n

SixFoisNeuf Used this blog to run cgit using fcgiwrap rather than a caddy plugin. The entire cgit with caddy section was using his work.

Mateja Maric Used this blog to help configure cgitrc, gitolite.rc

Luke Hsiao Used the git user creation command from this blog.

Omar Polo (yumh) Used this blog to help configure cgitrc for hidden repos.

Bryan Brattlof Not much used here, kept as reference.

Follow this porkbun guide on enabling the api for your domain.

ddns-updater is the program used to update Porkbun's A record of your domain.

Install the docker package from official docker repositories.

Create a directory with config.json inside, and make sure that its owner has a uid of 1000.

mkdir data\ntouch data/config.json\n# Owned by user ID of Docker container (1000)\nchown -R 1000 data\n# all access (for creating json database file data/updates.json)\nchmod 700 data\n# read access only\nchmod 400 data/config.json\n

Configuration for porkbun in config.json

{\n  \"settings\": [\n    {\n      \"provider\": \"porkbun\",\n      \"domain\": \"domain.com\",\n      \"host\": \"@\",\n      \"api_key\": \"PORKBUN SECRET KEY\",\n      \"secret_api_key\": \"PORKBUN API KEY\",\n      \"ip_version\": \"ipv4\"\n    }\n  ]\n}\n

Optional \"ttl\" paramter specifing A record TTL not included.

docker run -d -p 8000:8000/tcp -v \"$(pwd)\"/data:/updater/data qmcgaw/ddns-updater\n

This will start a docker container that will start updating the DNS records. Status updates can be seen in a web server by going to localhost:8000.

This page describes how I setup my personal webserver

I'm hosting a website, wiki, caldav using Radicale, git using cgit and Gitolite, and webdav support

Debian 12 Bookworm.

Update the system.

# apt update\n# apt upgrade\n

Generate ssh keys

ssh-keygen -t [keytype]\n

Add ssh keys to ~/.ssh/authorized_keys

ssh-copy-id -i /path/to/pubkey [user@]machine\n

Change the port in /etc/sshd_config to a nonstandard port to harden security.

Port 1234\n

Disable password login in /etc/sshd_config/

PubkeyAuthentication yes\nChallengeResponseAuthentication no\nPasswordAuthentication no\nKbdInteractiveAuthentication no\nUsePAM no\n

Disable XForwarding

X11Forwarding no\n

Disable remote root login

PermitRootLogin no\n

Setup Dyanmic DNS (ddns) with Porkbun and ddns-updater.

Install the Caddy package from Caddy directly.

Setup cgit with gitolite and caddy.

Install the Radicale package.

Start the Radicale service.

systemctl enable radicale.service\nsystemctl start radicale.service\n

Generate secure passwords using htpasswd.

# Create a new htpasswd file with the user \"user1\"\n$ htpasswd -c /path/to/users user1\nNew password:\nRe-type new password:\n# Add another user\n$ htpasswd /path/to/users user2\nNew password:\nRe-type new password:\n

Edit configuration to add users

[auth]\ntype = htpasswd\nhtpasswd_filename = /path/to/users\n# encryption method used in the htpasswd file\nhtpasswd_encryption = md5\n

Add configuration to caddy.

caldav.joshuayun.com {\n    handle_path /* {\n        reverse_proxy localhost:5232 {\n        header_up X-Script-Name /radicale\n        }\n    }\n    handle_path /radicale/* {\n        reverse_proxy localhost:5232 {\n            header_up X-Script-Name /radicale\n        }\n    }\n}\n

Add the Webdav module to Caddy.

sudo caddy add-package github.com/mholt/caddy-webdav\nsudo systemctl restart caddy\n

Add Webdav to the Caddy configuration

Example configuration with protected file browsing, see the github for more configurations.

webdav.joshuayun.com {\n    @get method GET\n    root * WEBDAV_PATH\n    route {\n        basicauth {\n            joshua CADDY_HASH\n        }\n        file_server @get browse\n        webdav\n    }\n}\n

To generate the hash:

caddy hash-password\n

Cgit with gitolite - Joshua's Wiki

+ + + + Skip to content + + +

+ +

+ + + + + + + + + + +

+ + Joshua's Wiki + +

+ + + Cgit with gitolite + + +

+ + + + + + + + + + + + + +

+ +

+ + + + + + +

+ + + +

+ + + + +

+ + + + + + + + Joshua's Wiki + + +

+ + + + + Home + + + + +
+ + + + + + + + + + + + Server + + + + + + +
+ + + Server + +
- + + + + + Server Setup + + + + +
- + + + + + + + + + + + + Cgit with gitolite + + + + + + + + + + + Cgit with gitolite + + + + + + + +
  + + + + + + + + + Table of contents + +
  - + + + Setup + + + +
  - + + + Gitolite + + + +
    +
    + +
    + + + Configuration with cgit + + + +
    + +
    + + + Usage + + + +
    + +
    + + + Repository ignore + + + +
    + +
    + + + Adding Hooks to gitolite + + + +
    + +
    +
    + +
  - + + + Cgit + + + +
    +
    + +
    + + + Running cgit with caddy + + + +
    + +
    +
    + +
  - + + + Cgit configuration + + + +
  - + + + References + + + +
  + +
  + +
- + + + + + DDNS + + + + +
+
+ +
+ + + + + About + + + + +

+ + + +

+ + +

+ + + + + + + + + Table of contents + +

+ + + Setup + + + +
+ + + Gitolite + + + +
+
- + + + Configuration with cgit + + + +
- + + + Usage + + + +
- + + + Repository ignore + + + +
- + + + Adding Hooks to gitolite + + + +
+
+ +
+ + + Cgit + + + +
+
- + + + Running cgit with caddy + + + +
+
+ +
+ + + Cgit configuration + + + +
+ + + References + + + +

+ +

+ + + +

+ + + + +

Cgit with gitolite and caddy

Setup

Install dependencies.

# apt install cgit python-is-python3 python3-pygments python3-markdown docutils-common groff perl
+

Make a git user.

sudo adduser --system --shell /bin/bash --group --disabled-password --home /home/git git
+

Allow ssh passwordless login.

usermod -p '*' username
+

Gitolite

Install the gitolite package from the repository directly.

Configuration with cgit

Configuration of gitolite is done by modifying $HOME/.gitolite.rc.

To work correctly with cgit, gitweb and cgit configuration options need to work with gitolite.

Change:

GIT_CONFIG_KEYS  =>  '',
+

To:

GIT_CONFIG_KEYS  =>  '.*',
+

To have permissions work correctly,

Change:

UMASK  =>  0077,
+

To:

UMASK  =>  0027,
+

In the ENABLE field, add gitweb and cgit to the list.

Usage

Detailed usage of gitolite can be found here

Repository ignore

After cgit is configured, cgit can be told to ignore a repo with this syntax.

repo gitolite-admin
+    config cgit.ignore=1
+

Adding Hooks to gitolite

This page details how to add hooks to your repositories.

Example hook that updates a website every git push. Make sure this directory is owned by git.

#!/bin/sh
+GIT_WORK_TREE=/desired/website/directory git checkout -f
+

Cgit

Running cgit with caddy

Install the fcgiwrap package.

Create a systemd service that wraps cgit with FastCGI.

# systemctl edit --full --force cgit.service
+

+ + +

[Unit]
+Description=CGI web interface to the Git SCM
+After=network.target
+
+[Service]
+Type=exec
+ExecStart=fcgiwrap -f -p "/usr/lib/cgit/cgit.cgi" -s tcp:127.0.0.1:8999
+
+[Install]
+WantedBy=multi-user.target
+

+ + +

# systemctl start cgit
+

Add cgit configuration to caddy.

git.joshuayun.com {
+        handle_path /cgit-css/* {
+                root * /usr/share/cgit/
+                file_server
+        }
+
+        handle {
+                reverse_proxy localhost:8999 {
+                        transport fastcgi {
+                                env DOCUMENT_ROOT /usr/lib/cgit/
+                                env SCRIPT_FILENAME /usr/lib/cgit/cgit.cgi
+                        }
+                }
+        }
+}
+

Cgit configuration

More detailed documentation can be found on the cgitrc(5) manual.

enable-git-config is used to allow for gitweb.* configurations in gitolite, e.g. description, owner.

enable-git-config=1
+

project-list sets where cgit looks for projects, this list is the one updated by gitolite

project-list=/home/git/projects.list
+

scan-path sets where the actual git repositories live

scan-path=/home/git/repositories
+

References

SixFoisNeuf Used this blog to run cgit using fcgiwrap rather than a caddy plugin. The entire cgit with caddy section was using his work.

Mateja Maric Used this blog to help configure cgitrc, gitolite.rc

Luke Hsiao Used the git user creation command from this blog.

Omar Polo (yumh) Used this blog to help configure cgitrc for hidden repos.

Bryan Brattlof Not much used here, kept as reference.

+ + + + + + + + + + + + + +

+ + + +

+ +

+ + + +

DDNS - Joshua's Wiki

+ + + + Skip to content + + +

+ +

+ + + + + + + + + + +

+ + Joshua's Wiki + +

+ + + DDNS + + +

+ + + + + + + + + + + + + +

+ +

+ + + + + + +

+ + + +

+ + + + +

+ + + + + + + + Joshua's Wiki + + +

+ + + + + Home + + + + +
+ + + + + + + + + + + + Server + + + + + + +
+ + + Server + +
- + + + + + Server Setup + + + + +
- + + + + + Cgit with gitolite + + + + +
- + + + + + + + + + + + + DDNS + + + + + + + + + + + DDNS + + + + + + + +
  + + + + + + + + + Table of contents + +
  - + + + Porkbun API + + + +
  - + + + ddns-updater + + + +
    +
    + +
    + + + Docker install + + + +
    + +
    + + + Setup + + + +
    + +
    + + + Usage + + + +
    + +
    +
    + +
  + +
  + +
+
+ +
+ + + + + About + + + + +

+ + + +

+ + + + +

DDNS Setup

Porkbun API

Follow this porkbun guide on enabling the api for your domain.

ddns-updater

ddns-updater is the program used to update Porkbun's A record of your domain.

Docker install

Install the docker package from official docker repositories.

Setup

Create a directory with config.json inside, and make sure that its owner has a uid of 1000.

mkdir data
+touch data/config.json
+# Owned by user ID of Docker container (1000)
+chown -R 1000 data
+# all access (for creating json database file data/updates.json)
+chmod 700 data
+# read access only
+chmod 400 data/config.json
+

Configuration for porkbun in config.json

{
+  "settings": [
+    {
+      "provider": "porkbun",
+      "domain": "domain.com",
+      "host": "@",
+      "api_key": "PORKBUN SECRET KEY",
+      "secret_api_key": "PORKBUN API KEY",
+      "ip_version": "ipv4"
+    }
+  ]
+}
+

Optional "ttl" paramter specifing A record TTL not included.

Usage

docker run -d -p 8000:8000/tcp -v "$(pwd)"/data:/updater/data qmcgaw/ddns-updater
+

This will start a docker container that will start updating the DNS records. +Status updates can be seen in a web server by going to localhost:8000.

+ + + + + + + + + + + + + +

+ + + +

+ +

+ + + +

Server Setup - Joshua's Wiki

+ + + + Skip to content + + +

+ +

+ + + + + + + + + + +

+ + Joshua's Wiki + +

+ + + Server Setup + + +

+ + + + + + + + + + + + + +

+ +

+ + + + + + +

+ + + +

+ + + + +

+ + + + + + + + Joshua's Wiki + + +

+ + + + + Home + + + + +
+ + + + + + + + + + + + Server + + + + + + +
+ + + Server + +
- + + + + + + + + + + + + Server Setup + + + + + + + + + + + Server Setup + + + + + + + +
  + + + + + + + + + Table of contents + +
  - + + + Linux Distribution Used + + + +
  - + + + SSH + + + +
    +
    + +
    + + + Optional security enhancements + + + +
    + +
    +
    + +
  - + + + DDNS + + + +
  - + + + Caddy + + + +
  - + + + Cgit & gitolite + + + +
  - + + + Radicale + + + +
  - + + + Webdav + + + +
  + +
  + +
- + + + + + Cgit with gitolite + + + + +
- + + + + + DDNS + + + + +
+
+ +
+ + + + + About + + + + +

+ + + +

+ + +

+ + + + + + + + + Table of contents + +

+ + + Linux Distribution Used + + + +
+ + + SSH + + + +
+
- + + + Optional security enhancements + + + +
+
+ +
+ + + DDNS + + + +
+ + + Caddy + + + +
+ + + Cgit & gitolite + + + +
+ + + Radicale + + + +
+ + + Webdav + + + +

+ +

+ + + +

+ + + + +

Homelab Server Setup

This page describes how I setup my personal webserver

I'm hosting a website, wiki, caldav using Radicale, git using cgit and Gitolite, and webdav support

Linux Distribution Used

Debian 12 Bookworm.

Update the system.

# apt update
+# apt upgrade
+

SSH

Generate ssh keys

ssh-keygen -t [keytype]
+

Add ssh keys to ~/.ssh/authorized_keys

ssh-copy-id -i /path/to/pubkey [user@]machine
+

Optional security enhancements

Change the port in /etc/sshd_config to a nonstandard port to harden security.

Port 1234
+

Disable password login in /etc/sshd_config/

PubkeyAuthentication yes
+ChallengeResponseAuthentication no
+PasswordAuthentication no
+KbdInteractiveAuthentication no
+UsePAM no
+

Disable XForwarding

X11Forwarding no
+

Disable remote root login

PermitRootLogin no
+

DDNS

Setup Dyanmic DNS (ddns) with Porkbun and ddns-updater.

Caddy

Install the Caddy package from Caddy directly.

Cgit & gitolite

Setup cgit with gitolite and caddy.

Radicale

Install the Radicale package.

Start the Radicale service.

systemctl enable radicale.service
+systemctl start radicale.service
+

Generate secure passwords using htpasswd.

# Create a new htpasswd file with the user "user1"
+$ htpasswd -c /path/to/users user1
+New password:
+Re-type new password:
+# Add another user
+$ htpasswd /path/to/users user2
+New password:
+Re-type new password:
+

Edit configuration to add users

[auth]
+type = htpasswd
+htpasswd_filename = /path/to/users
+# encryption method used in the htpasswd file
+htpasswd_encryption = md5
+

Add configuration to caddy.

caldav.joshuayun.com {
+    handle_path /* {
+        reverse_proxy localhost:5232 {
+        header_up X-Script-Name /radicale
+        }
+    }
+    handle_path /radicale/* {
+        reverse_proxy localhost:5232 {
+            header_up X-Script-Name /radicale
+        }
+    }
+}
+

Webdav

Add the Webdav module to Caddy.

sudo caddy add-package github.com/mholt/caddy-webdav
+sudo systemctl restart caddy
+

Add Webdav to the Caddy configuration

Example configuration with protected file browsing, see the github for more configurations.

webdav.joshuayun.com {
+    @get method GET
+    root * WEBDAV_PATH
+    route {
+        basicauth {
+            joshua CADDY_HASH
+        }
+        file_server @get browse
+        webdav
+    }
+}
+

To generate the hash:

caddy hash-password
+

+ + + + + + + + + + + + + +

+ + + +

+ +

+ + + +

+ + https://wiki.joshuayun.com/ + 2023-12-30 + daily + + + https://wiki.joshuayun.com/about/ + 2023-12-30 + daily + + + https://wiki.joshuayun.com/server/cgit/ + 2023-12-30 + daily + + + https://wiki.joshuayun.com/server/ddns/ + 2023-12-30 + daily + + + https://wiki.joshuayun.com/server/server/ + 2023-12-30 + daily +