diff options
Diffstat (limited to 'site/search')
| -rw-r--r-- | site/search/search_index.json | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/site/search/search_index.json b/site/search/search_index.json index 14ce2a2..8c87758 100644 --- a/site/search/search_index.json +++ b/site/search/search_index.json @@ -1 +1 @@ -{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Welcome to Joshua's Wiki","text":"<p>This is where I will be putting my stuff on how to configure things</p>"},{"location":"#commands","title":"Commands","text":"<ul> <li><code>mkdocs new [dir-name]</code> - Create a new project.</li> <li><code>mkdocs serve</code> - Start the live-reloading docs server.</li> <li><code>mkdocs build</code> - Build the documentation site.</li> <li><code>mkdocs -h</code> - Print help message and exit.</li> </ul>"},{"location":"#project-layout","title":"Project layout","text":"<pre><code>mkdocs.yml # The configuration file.\ndocs/\n index.md # The documentation homepage.\n ... # Other markdown pages, images and other files.\n</code></pre>"},{"location":"about/","title":"About this wiki","text":"<p>This is where I will be putting my stuff on how to configure things as well as some other personal references.</p>"},{"location":"server/cgit/","title":"Cgit with gitolite and caddy","text":""},{"location":"server/cgit/#setup","title":"Setup","text":"<p>Install dependencies.</p> <pre><code># apt install cgit python-is-python3 python3-pygments python3-markdown docutils-common groff perl\n</code></pre> <p>Make a git user.</p> <pre><code>sudo adduser --system --shell /bin/bash --group --disabled-password --home /home/git git\n</code></pre> <p>Allow ssh passwordless login.</p> <pre><code>usermod -p '*' username\n</code></pre>"},{"location":"server/cgit/#gitolite","title":"Gitolite","text":"<p>Install the gitolite package from the repository directly.</p>"},{"location":"server/cgit/#configuration-with-cgit","title":"Configuration with cgit","text":"<p>Configuration of gitolite is done by modifying <code>$HOME/.gitolite.rc</code>.</p> <p>To work correctly with cgit, gitweb and cgit configuration options need to work with gitolite.</p> <p>Change:</p> <pre><code>GIT_CONFIG_KEYS => '',\n</code></pre> <p>To:</p> <pre><code>GIT_CONFIG_KEYS => '.*',\n</code></pre> <p>To have permissions work correctly,</p> <p>Change:</p> <pre><code>UMASK => 0077,\n</code></pre> <p>To:</p> <pre><code>UMASK => 0027,\n</code></pre> <p>In the <code>ENABLE</code> field, add gitweb and cgit to the list.</p>"},{"location":"server/cgit/#usage","title":"Usage","text":"<p>Detailed usage of gitolite can be found here</p>"},{"location":"server/cgit/#repository-ignore","title":"Repository ignore","text":"<p>After cgit is configured, cgit can be told to ignore a repo with this syntax.</p> <pre><code>repo gitolite-admin\n config cgit.ignore=1\n</code></pre>"},{"location":"server/cgit/#adding-hooks-to-gitolite","title":"Adding Hooks to gitolite","text":"<p>This page details how to add hooks to your repositories.</p> <p>Example hook that updates a website every git push. Make sure this directory is owned by git.</p> <pre><code>#!/bin/sh\nGIT_WORK_TREE=/desired/website/directory git checkout -f\n</code></pre>"},{"location":"server/cgit/#cgit","title":"Cgit","text":""},{"location":"server/cgit/#running-cgit-with-caddy","title":"Running cgit with caddy","text":"<p>Install the fcgiwrap package.</p> <p>Create a systemd service that wraps cgit with FastCGI.</p> <pre><code># systemctl edit --full --force cgit.service\n</code></pre> <pre><code>[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</code></pre> <pre><code># systemctl start cgit\n</code></pre> <p>Add cgit configuration to caddy.</p> <pre><code>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</code></pre>"},{"location":"server/cgit/#cgit-configuration","title":"Cgit configuration","text":"<p>More detailed documentation can be found on the cgitrc(5) manual.</p> <p>enable-git-config is used to allow for gitweb.* configurations in gitolite, e.g. description, owner.</p> <pre><code>enable-git-config=1\n</code></pre> <p>project-list sets where cgit looks for projects, this list is the one updated by gitolite</p> <pre><code>project-list=/home/git/projects.list\n</code></pre> <p>scan-path sets where the actual git repositories live</p> <pre><code>scan-path=/home/git/repositories\n</code></pre>"},{"location":"server/cgit/#references","title":"References","text":"<p>SixFoisNeuf Used this blog to run cgit using fcgiwrap rather than a caddy plugin. The entire cgit with caddy section was using his work.</p> <p>Mateja Maric Used this blog to help configure cgitrc, gitolite.rc</p> <p>Luke Hsiao Used the git user creation command from this blog.</p> <p>Omar Polo (yumh) Used this blog to help configure cgitrc for hidden repos.</p> <p>Bryan Brattlof Not much used here, kept as reference.</p>"},{"location":"server/ddns/","title":"DDNS Setup","text":""},{"location":"server/ddns/#porkbun-api","title":"Porkbun API","text":"<p>Follow this porkbun guide on enabling the api for your domain.</p>"},{"location":"server/ddns/#ddns-updater","title":"ddns-updater","text":"<p>ddns-updater is the program used to update Porkbun's A record of your domain.</p>"},{"location":"server/ddns/#docker-install","title":"Docker install","text":"<p>Install the docker package from official docker repositories.</p>"},{"location":"server/ddns/#setup","title":"Setup","text":"<p>Create a directory with config.json inside, and make sure that its owner has a uid of 1000.</p> <pre><code>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</code></pre> <p>Configuration for porkbun in config.json</p> <pre><code>{\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</code></pre> <p>Optional <code>\"ttl\"</code> paramter specifing A record TTL not included.</p>"},{"location":"server/ddns/#usage","title":"Usage","text":"<pre><code>docker run -d -p 8000:8000/tcp -v \"$(pwd)\"/data:/updater/data qmcgaw/ddns-updater\n</code></pre> <p>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.</p>"},{"location":"server/server/","title":"Homelab Server Setup","text":"<p>This page describes how I setup my personal webserver</p> <p>I'm hosting a website, wiki, caldav using Radicale, git using cgit and Gitolite, and webdav support</p>"},{"location":"server/server/#linux-distribution-used","title":"Linux Distribution Used","text":"<p>Debian 12 Bookworm.</p> <p>Update the system.</p> <pre><code># apt update\n# apt upgrade\n</code></pre>"},{"location":"server/server/#ssh","title":"SSH","text":"<p>Generate ssh keys</p> <pre><code>ssh-keygen -t [keytype]\n</code></pre> <p>Add ssh keys to <code>~/.ssh/authorized_keys</code></p> <pre><code>ssh-copy-id -i /path/to/pubkey [user@]machine\n</code></pre>"},{"location":"server/server/#optional-security-enhancements","title":"Optional security enhancements","text":"<p>Change the port in <code>/etc/sshd_config</code> to a nonstandard port to harden security.</p> <pre><code>Port 1234\n</code></pre> <p>Disable password login in <code>/etc/sshd_config/</code></p> <pre><code>PubkeyAuthentication yes\nChallengeResponseAuthentication no\nPasswordAuthentication no\nKbdInteractiveAuthentication no\nUsePAM no\n</code></pre> <p>Disable XForwarding</p> <pre><code>X11Forwarding no\n</code></pre> <p>Disable remote root login</p> <pre><code>PermitRootLogin no\n</code></pre>"},{"location":"server/server/#ddns","title":"DDNS","text":"<p>Setup Dyanmic DNS (ddns) with Porkbun and ddns-updater.</p>"},{"location":"server/server/#caddy","title":"Caddy","text":"<p>Install the Caddy package from Caddy directly.</p>"},{"location":"server/server/#cgit-gitolite","title":"Cgit & gitolite","text":"<p>Setup cgit with gitolite and caddy.</p>"},{"location":"server/server/#radicale","title":"Radicale","text":"<p>Install the Radicale package.</p> <p>Start the Radicale service.</p> <pre><code>systemctl enable radicale.service\nsystemctl start radicale.service\n</code></pre> <p>Generate secure passwords using htpasswd.</p> <pre><code># 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</code></pre> <p>Edit configuration to add users</p> <pre><code>[auth]\ntype = htpasswd\nhtpasswd_filename = /path/to/users\n# encryption method used in the htpasswd file\nhtpasswd_encryption = md5\n</code></pre> <p>Add configuration to caddy.</p> <pre><code>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</code></pre>"},{"location":"server/server/#webdav","title":"Webdav","text":"<p>Add the Webdav module to Caddy.</p> <pre><code>sudo caddy add-package github.com/mholt/caddy-webdav\nsudo systemctl restart caddy\n</code></pre> <p>Add Webdav to the Caddy configuration</p> <p>Example configuration with protected file browsing, see the github for more configurations.</p> <pre><code>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</code></pre> <p>To generate the hash:</p> <pre><code>caddy hash-password\n</code></pre>"}]}
\ No newline at end of file +{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Welcome to Joshua's Wiki","text":"<p>This is where I will be putting my stuff on how to configure things</p>"},{"location":"about/","title":"About this wiki","text":"<p>This is where I will be putting my stuff on how to configure things as well as some other personal references.</p>"},{"location":"desktop/desktop/","title":"Desktop Wiki","text":"<p>This page describes several useful tips and configurations that I've used.</p> <p>Thunderbird</p>"},{"location":"desktop/thunderbird/","title":"Thunderbird","text":""},{"location":"desktop/thunderbird/#setting-dateformat","title":"Setting dateformat","text":"<p>Usually the date format is not in AM/PM. Unfortunately, I'm American, so here's how I change it.</p> <ol> <li>Go to settings in Thunderbird.</li> <li>Change Date and Time Formatting to Regional settings locale.</li> <li>Go to config editor at the bottom of general settings.</li> <li>Create new config string intl.date_time.pattern_overrite.time_short.</li> <li>Format follows datetime format, I use hh:mmaaaa.</li> <li>Restart Thunderbird.</li> </ol> <p>References:</p> <p>Linux Mint formum detailing these instructions</p> <p>Datetime Reference</p> <p>Mozilla Article on customizing formats</p>"},{"location":"server/cgit/","title":"Cgit with gitolite and caddy","text":""},{"location":"server/cgit/#setup","title":"Setup","text":"<p>Install dependencies.</p> <pre><code># apt install cgit python-is-python3 python3-pygments python3-markdown docutils-common groff perl\n</code></pre> <p>Make a git user.</p> <pre><code>sudo adduser --system --shell /bin/bash --group --disabled-password --home /home/git git\n</code></pre> <p>Allow ssh passwordless login.</p> <pre><code>usermod -p '*' username\n</code></pre>"},{"location":"server/cgit/#gitolite","title":"Gitolite","text":"<p>Install the gitolite package from the repository directly.</p>"},{"location":"server/cgit/#configuration-with-cgit","title":"Configuration with cgit","text":"<p>Configuration of gitolite is done by modifying <code>$HOME/.gitolite.rc</code>.</p> <p>To work correctly with cgit, gitweb and cgit configuration options need to work with gitolite.</p> <p>Change:</p> <pre><code>GIT_CONFIG_KEYS => '',\n</code></pre> <p>To:</p> <pre><code>GIT_CONFIG_KEYS => '.*',\n</code></pre> <p>To have permissions work correctly,</p> <p>Change:</p> <pre><code>UMASK => 0077,\n</code></pre> <p>To:</p> <pre><code>UMASK => 0027,\n</code></pre> <p>In the <code>ENABLE</code> field, add gitweb and cgit to the list.</p>"},{"location":"server/cgit/#usage","title":"Usage","text":"<p>Detailed usage of gitolite can be found here</p>"},{"location":"server/cgit/#repository-ignore","title":"Repository ignore","text":"<p>After cgit is configured, cgit can be told to ignore a repo with this syntax.</p> <pre><code>repo gitolite-admin\n config cgit.ignore=1\n</code></pre>"},{"location":"server/cgit/#adding-hooks-to-gitolite","title":"Adding Hooks to gitolite","text":"<p>This page details how to add hooks to your repositories.</p> <p>Example hook that updates a website every git push. Make sure this directory is owned by git.</p> <pre><code>#!/bin/sh\nGIT_WORK_TREE=/desired/website/directory git checkout -f\n</code></pre>"},{"location":"server/cgit/#cgit","title":"Cgit","text":""},{"location":"server/cgit/#running-cgit-with-caddy","title":"Running cgit with caddy","text":"<p>Install the fcgiwrap package.</p> <p>Create a systemd service that wraps cgit with FastCGI.</p> <pre><code># systemctl edit --full --force cgit.service\n</code></pre> <pre><code>[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</code></pre> <pre><code># systemctl start cgit\n</code></pre> <p>Add cgit configuration to caddy.</p> <pre><code>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</code></pre>"},{"location":"server/cgit/#cgit-configuration","title":"Cgit configuration","text":"<p>More detailed documentation can be found on the cgitrc(5) manual.</p> <p>enable-git-config is used to allow for gitweb.* configurations in gitolite, e.g. description, owner.</p> <pre><code>enable-git-config=1\n</code></pre> <p>project-list sets where cgit looks for projects, this list is the one updated by gitolite</p> <pre><code>project-list=/home/git/projects.list\n</code></pre> <p>scan-path sets where the actual git repositories live</p> <pre><code>scan-path=/home/git/repositories\n</code></pre>"},{"location":"server/cgit/#references","title":"References","text":"<p>SixFoisNeuf Used this blog to run cgit using fcgiwrap rather than a caddy plugin. The entire cgit with caddy section was using his work.</p> <p>Mateja Maric Used this blog to help configure cgitrc, gitolite.rc</p> <p>Luke Hsiao Used the git user creation command from this blog.</p> <p>Omar Polo (yumh) Used this blog to help configure cgitrc for hidden repos.</p> <p>Bryan Brattlof Not much used here, kept as reference.</p>"},{"location":"server/ddns/","title":"DDNS Setup","text":""},{"location":"server/ddns/#porkbun-api","title":"Porkbun API","text":"<p>Follow this porkbun guide on enabling the api for your domain.</p>"},{"location":"server/ddns/#ddns-updater","title":"ddns-updater","text":"<p>ddns-updater is the program used to update Porkbun's A record of your domain.</p>"},{"location":"server/ddns/#docker-install","title":"Docker install","text":"<p>Install the docker package from official docker repositories.</p>"},{"location":"server/ddns/#setup","title":"Setup","text":"<p>Create a directory with config.json inside, and make sure that its owner has a uid of 1000.</p> <pre><code>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</code></pre> <p>Configuration for porkbun in config.json</p> <pre><code>{\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</code></pre> <p>Optional <code>\"ttl\"</code> paramter specifing A record TTL not included.</p>"},{"location":"server/ddns/#usage","title":"Usage","text":"<pre><code>docker run -d -p 8000:8000/tcp -v \"$(pwd)\"/data:/updater/data qmcgaw/ddns-updater\n</code></pre> <p>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.</p>"},{"location":"server/server/","title":"Homelab Server Setup","text":"<p>This page describes how I setup my personal webserver</p> <p>I'm hosting a website, wiki, caldav using Radicale, git using cgit and Gitolite, and webdav support</p>"},{"location":"server/server/#linux-distribution-used","title":"Linux Distribution Used","text":"<p>Debian 12 Bookworm.</p> <p>Update the system.</p> <pre><code># apt update\n# apt upgrade\n</code></pre>"},{"location":"server/server/#ssh","title":"SSH","text":"<p>Generate ssh keys</p> <pre><code>ssh-keygen -t [keytype]\n</code></pre> <p>Add ssh keys to <code>~/.ssh/authorized_keys</code></p> <pre><code>ssh-copy-id -i /path/to/pubkey [user@]machine\n</code></pre>"},{"location":"server/server/#optional-security-enhancements","title":"Optional security enhancements","text":"<p>Change the port in <code>/etc/sshd_config</code> to a nonstandard port to harden security.</p> <pre><code>Port 1234\n</code></pre> <p>Disable password login in <code>/etc/sshd_config/</code></p> <pre><code>PubkeyAuthentication yes\nChallengeResponseAuthentication no\nPasswordAuthentication no\nKbdInteractiveAuthentication no\nUsePAM no\n</code></pre> <p>Disable XForwarding</p> <pre><code>X11Forwarding no\n</code></pre> <p>Disable remote root login</p> <pre><code>PermitRootLogin no\n</code></pre>"},{"location":"server/server/#ddns","title":"DDNS","text":"<p>Setup Dyanmic DNS (ddns) with Porkbun and ddns-updater.</p>"},{"location":"server/server/#caddy","title":"Caddy","text":"<p>Install the Caddy package from Caddy directly.</p>"},{"location":"server/server/#cgit-gitolite","title":"Cgit & gitolite","text":"<p>Setup cgit with gitolite and caddy.</p>"},{"location":"server/server/#radicale","title":"Radicale","text":"<p>Install the Radicale package.</p> <p>Start the Radicale service.</p> <pre><code>systemctl enable radicale.service\nsystemctl start radicale.service\n</code></pre> <p>Generate secure passwords using htpasswd.</p> <pre><code># 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</code></pre> <p>Edit configuration to add users</p> <pre><code>[auth]\ntype = htpasswd\nhtpasswd_filename = /path/to/users\n# encryption method used in the htpasswd file\nhtpasswd_encryption = md5\n</code></pre> <p>Add configuration to caddy.</p> <pre><code>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</code></pre>"},{"location":"server/server/#webdav","title":"Webdav","text":"<p>Add the Webdav module to Caddy.</p> <pre><code>sudo caddy add-package github.com/mholt/caddy-webdav\nsudo systemctl restart caddy\n</code></pre> <p>Add Webdav to the Caddy configuration</p> <p>Example configuration with protected file browsing, see the github for more configurations.</p> <pre><code>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</code></pre> <p>To generate the hash:</p> <pre><code>caddy hash-password\n</code></pre>"}]}
\ No newline at end of file |