diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 12 |
1 files changed, 11 insertions, 1 deletions
@@ -11,6 +11,7 @@ chroot environment, who knows. # Features * Will try to process URLs in this order: + 0. Checks if API endpoint exists at that URL, and if it does, and executes it. 0. Checks if URL is a shortened link name, and if it is, redirects there. 0. Tries to send a file at the location pointed to by URL (relative to @@ -18,6 +19,7 @@ chroot environment, who knows. 0. Tries to format file like this: `www/{URL}.html` and display the page \[e.g. `/docs` -> `www/docs.html`\] 0. Returns 404 + * \[In future\]: uses `inotify` to track changes in `endpoints.so` and reload it * \[In future\]: `SIGUSR1` makes it reload `endpoints.so` @@ -26,6 +28,7 @@ Pretty small. See [html docs page](www/docs.html). # Build ## Requirements +0. `make` 0. `gperf` 0. `cc` 0. linker that supports `.ld` scripts @@ -36,8 +39,15 @@ all of the paths can be configured in [`Makefile`](Makefile) ## Steps `make` +# Run +0. Copy `config.env.default` to `config.env`, change environment variables in +there to match your needs +0. `make run`, or `env $(cat config.env) ./main`, or `. config.env && ./main`, +whichever fits your needs the most. + # License -AGPL. Sorry fellas, gotta stay free (as in "freedom"). +AGPL. Sorry fellas, gotta stay free (as in "freedom"). Also, +[sorry, google employees](https://opensource.google/documentation/reference/patching#forbidden) # Contributing [my email](mailto:sotov@twistea.su) |