aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMichael McVady <femtonaut@gmail.com>2023-02-18 20:47:36 -0600
committerMichael McVady <femtonaut@gmail.com>2023-02-18 20:47:36 -0600
commit36909982aae7fb6297ba8a4aaf8dc08fdbbd922b (patch)
treea3132513b71ff2f6d9fe8647396f8ca3a3d77afb /README.md
parent131781932976d6a9b617abbac4566276d336e0c2 (diff)
Update `README.md`
Diffstat (limited to 'README.md')
-rw-r--r--README.md31
1 files changed, 12 insertions, 19 deletions
diff --git a/README.md b/README.md
index a3a885f..6b2533c 100644
--- a/README.md
+++ b/README.md
@@ -2,23 +2,26 @@
An attempt to reimplement flog, using the [kore.io](https://kore.io) framework.
-# Building
+## Building
```
make fetch-dependencies
docker compose up
```
-# Notes
+## Notes
-To run locally comment out the `privsep worker` section in `conf/clog.conf`:
+To run locally modify `conf/clog.conf`, comment out `root /var/chroot/` and uncomment
+the `skip chroot` section:
```
-# privsep worker {
-# runas clog
-#
-# root /var/chroot/
-# }
+privsep worker {
+ runas clog
+
+ # root /var/chroot/
+
+ skip chroot
+}
```
Maybe disable `seccomp_tracing` in `conf/clog.conf` if running into problems:
@@ -36,15 +39,5 @@ seccomp_tracing no
## TODO
* Have `tests.py` load and drop database.
-* Test content-type in responses.
-
-Add functions:
-
-get_request_type
-render_json_error
-render_html_error
-
-insert_post
-
-only do HTTP stuff at the edge.
+* only do HTTP stuff at the edge.