summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md57
1 files changed, 57 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..63fc136
--- /dev/null
+++ b/README.md
@@ -0,0 +1,57 @@
+# achernar
+
+This repository contains the source code for Achernar's webservice at `https://achernar.dk`.
+
+## Testing
+
+Use the installation script at `install.sh` to install the server.
+
+If using nginx, add the following server to your configuration (assuming installation at `/srv/achernar`):
+
+```
+server {
+ listen 8080;
+ server_name localhost;
+
+ location = / {
+ return 307 /html/about.html;
+ }
+
+ location = /apple-touch-icon.png {
+ alias /srv/achernar/apple-touch-icon.png;
+ }
+
+ location = /favicon.ico {
+ alias /srv/achernar/favicon.ico;
+ }
+
+ location /css {
+ alias /srv/achernar/css;
+ }
+
+ location /font {
+ alias /srv/achernar/font;
+ }
+
+ location /html {
+ alias /srv/achernar/html;
+ ssi on;
+ }
+
+ location /image {
+ alias /srv/achernar/image;
+ }
+
+ location /include {
+ alias /srv/achernar/include;
+ }
+
+ location /js {
+ alias /srv/achernar/js;
+ }
+
+ location /svg {
+ alias /srv/achernar/svg;
+ }
+}
+```