add more docs

Author: ss1h2a3tw

CONFIGURATION.md

@@ -0,0 +1,44 @@
+PULXC Configuration
+===
+
+## file structure
+```
+/var/lib/pulxc/: storage of the users' lxc
+/etc/pulxc/: config for pulxc
+/usr/lib/pulxc/: the shell scripts, helpers
+/usr/bin/: pulxc-attach, pulxc-create, pulxc-destroy
+/usr/lib/systemd/system/: unit files
+```
+In `/var/lib/pulxc` there are `lxc/` `log/`
+
+All pulxc will be stored inside `lxc/` as the way `--lxcpath=/var/lib/pulxc/lxc` in the argument calling lxc
+
+If you start the `pulxc-dblg@username` service the log will be saved at `log/username.log`
+
+
+## config
+
+### pulxc.conf
+
+`/etc/pulxc/pulxc` is the main config file
+
+The format is `KEY=VALUE` the `VALUE` should only consist alphanumeric and `_-/`
+
+Key | Description
+--- | ---
+BASE_PATH| the place where users' lxc should save at
+BASE_SUBUID| subuid start of pulxc
+BASE_SUBGID| subgid start of pulxc
+CGROUP_CPUSET_CPUS| the cgroup cpuset.cpus settings for all pulxc (in total)
+CGROUP_CPUSET_MEMS| the cgroup cpuset.mems settings for all pulxc (in total)
+BRIDGE_INTERFACE| the bridge the pulxc will connect to
+IP_PREFIX| the first 3 part of the ipv4 address of pulxc
+GATEWAY| the gateway address
+
+because it is hard coded to run as /24 subnet
+
+you can modify the pulxc-create if you want other subnet size
+
+### pulxc-lxc.conf
+
+This file will be included by lxc itself, you can set configs to every pulxc, for example , cap drops.

INSTALL.md

@@ -0,0 +1,48 @@
+PULXC installation
+===
+## Installation
+
+If you are using archlinux, you can install from pulxc-git in AUR
+
+But you still need to configure sysctl and lxc-usernet
+
+### Add conf to sysctl.d
+`kernel.uprivileged_userns_clone=1`
+### setup lxc-usernet
+```
+#/etc/lxc/lxc-usernet
+pulxc veth pulxcbr0 99 255
+```
+### add user pulxc:pulxc
+`useradd -b /var/lib -m -r pulxc`
+### configure subuid subgid
+```
+touch /etc/subuid
+touch /etc/subgid
+usermod -v 100000-165535 -w 100000-165535 pulxc
+```
+### configure bridge
+
+use the tool you want
+```
+#/etc/systemd/network/pulxcbr0.netdev
+[NetDev]
+Name=pulxcbr0
+Kind=bridge
+```
+```
+#/etc/systemd/network/pulxcbr0.network
+[Match]
+Name=pulxcbr0
+
+[Network]
+Address=192.168.100.254/24
+```
+configure ip forwarding and NAT if you need it.
+
+### install the files
+you can modify the uid/gid/subuid/subgid in Makefile to meet your pulxc's uid/gid/subuid/subgid
+```
+make
+make install
+```

README.md

@@ -21,6 +21,8 @@ make
 sudo make install
 ```
 
+read INSTALL.md for more info
+
 ## Usage
 
 `pulxc-create username` to create a lxc for the user
@@ -34,3 +36,5 @@ sudo make install
 `systemctl enable pulxc@username` to make it start at boot
 
 `systemctl start pulxc-dblg@username` to log the startup, the log file will be saved at /var/lib/pulxc/log/
+
+for more info, read CONFIGURATION.md