From 30521b6056a35d6744a4805fc76bc26ce887f8b9 Mon Sep 17 00:00:00 2001 From: Aidan Date: Tue, 26 Nov 2024 10:29:25 -0500 Subject: [PATCH] add documentation, gitignore entry for archive dir --- .gitignore | 5 ++++- README.md | 26 +++++++++++++++----------- 2 files changed, 19 insertions(+), 12 deletions(-) diff --git a/.gitignore b/.gitignore index 8086401..ca7c341 100644 --- a/.gitignore +++ b/.gitignore @@ -2,4 +2,7 @@ .idea/ # public directory -public/ \ No newline at end of file +public/ + +# archives directory +src/archives/ \ No newline at end of file diff --git a/README.md b/README.md index 530b44a..ade35ea 100644 --- a/README.md +++ b/README.md @@ -9,22 +9,26 @@ There are two self-hosted options, depending on your situation. For my purposes, 1. **Use self script** The `self` script can help you establish a public/ folder, where code can be served to. At this time, it doesn't do anything but move the files over as of now. This script is only supported on Linux hosts. -To use the self script, you must do the following: + To use the self script, you must do the following: -**a.** Allow execution of self script + **a.** Allow execution of self script -```shell -chmod +x self -``` + ```shell + chmod +x self + ``` -**b.** Start server + **b.** Start server -```shell -./self start -``` + ```shell + ./self start + ``` -You may also use `./self help` (this script does not provide therapy services) to view other available commands. + You may also use `./self help` (this script does not provide therapy services) to view other available commands. 2. **Use the static files** -You may also opt to copy the src/ folder to another location, such as /var/www/html, so it can be served static with a web server such as Apache2 or NGINX. \ No newline at end of file + You may also opt to copy the src/ folder to another location, such as /var/www/html, so it can be served static with a web server such as Apache2 or NGINX. + +# Serve custom files + +If you would like to host your own files, simply place them in `./src/archives`, and they will be served at the same location mine are. Keep in mind, you may not use the same directory structure, and will have to update the menu links. \ No newline at end of file