diff options
| author | Carson Fleming <cflems@cflems.net> | 2025-01-24 20:57:54 -0500 |
|---|---|---|
| committer | Carson Fleming <cflems@cflems.net> | 2025-01-24 20:57:54 -0500 |
| commit | 20e78c828e3995371a5ed29f3f53514370b7c152 (patch) | |
| tree | e8d738d41be5cb9c657babf66facb8ef7459abab /server.php | |
| download | pk-20e78c828e3995371a5ed29f3f53514370b7c152.tar.gz | |
host docs here now
Diffstat (limited to 'server.php')
| -rw-r--r-- | server.php | 74 |
1 files changed, 74 insertions, 0 deletions
diff --git a/server.php b/server.php new file mode 100644 index 0000000..4cbd1f0 --- /dev/null +++ b/server.php @@ -0,0 +1,74 @@ +<!DOCTYPE html> +<html lang="en"> + <head> +<?php +require('include/meta.php'); +?> + <title>Server Configuration | Docs | Penguin's Kiss</title> + <link rel="canonical" href="https://c2.pkctl.org/server" /> + </head> +<?php +require('include/header.php'); +?> + <p>Once your PK scripts are built very little is required to run the server as a local + user, you can literally just do:</p> + <pre>python3 pkctl.py start +python3 pkctl.py attach</pre> + <p>and have yourself a simple instance up and running ready to run commands. Therefore + the rest of this section will be dedicated to getting PK running in the background + as a systemd service under its own user, and letting multiple system users attach + to the daemon at once if desired.</p> + <section id="install"> + <h3>Installing</h3> + <p>Once again the makefile mostly has you covered here, all you need to do is:</p> + <pre>sudo make install</pre> + <p>and the makefile will set up a dedicated service user and group called + <code>pkd</code> which controls access to the daemon and its resources, as well + as setting up the pk server as a systemd service called <code>pk</code>. This + will also start the pk server and enable it on startup.</p> + </section> + <section id="pkctl"> + <h3>PKCTL Usage</h3> + <p>Once installed, you can use the following commands to interface with the pk + daemon controller:</p> + <p><code>systemctl start|stop|restart pk</code> — this controls the + daemon's life cycle.</p> + <p><code>pkctl attach</code> — this starts an interactive session with the + daemon, allowing you to control and interface with clients.</p> + </section> + <section id="keygen"> + <h3>Host Key Generation</h3> + <p>Once you've installed the pk server you're going to want to change its + host key away from the default one which is used for testing purposes and is + widely available (read: not secure at all).</p> + <p>This is probably the only complicated part of the whole guide, mostly because + I haven't yet built a cute little utility to do it for you yet (I should + at some point). You're going to need to do the following (in your pk + directory):</p> + <pre>python3 +>>> import crypto +>>> p,q,n,e,d = crypto.Crypto.keygen(4096) +>>> n</pre> + <p>Copy the number that python spits out here.</p> + <pre> +>>> d</pre> + <p>Also copy this number. Keep these two handy as we'll need them later. + Now open <code>/etc/pk/server_key.json</code> in your favorite editor and make + it read as follows (you can wipe out the current contents):</p> + <pre>{"n": <the number n we got from python>, "d": <the number d we got from python>, "e": 65537}</pre> + <p>At this point we're almost done, we just have to restart pk to reflect the + changes, so run:</p> + <pre>sudo systemctl restart pk</pre> + <p>and you should be good to go.</p> + </section> + <section id="users"> + <h3>Local Users</h3> + <p>To allow non-root users on your system to use <code>pkctl attach</code>, you + will need to add them to the <code>pkd</code> user group. This is remarkably + simple to do on any unix system, just run:</p> + <pre>adduser [username] pkd</pre> + </section> +<?php +require('include/footer.php'); +?> +</html> |