aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorjohn <18413674+grravity@users.noreply.github.com>2021-04-01 19:33:24 +0000
committerGitHub <noreply@github.com>2021-04-01 19:33:24 +0000
commit408eb81a7b45ebd33cd2d89ab07c3047fa2e23b2 (patch)
tree8c1c93e3f1c3b318ffdd898acd54e2226e1106d6 /README.md
parent057e0ab1f4064e70bd9bcb0370a0c2d5e23e0789 (diff)
Improved
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 9 insertions, 8 deletions
diff --git a/README.md b/README.md
index 0bb6e35..1e2621a 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
# About
-FChannel is a libre, self-hostable, federated, imageboard platform that utilizes ActivittPub.
+FChannel is a [libre](https://en.wikipedia.org/wiki/Free_and_open-source_software), [self-hostable](https://en.wikipedia.org/wiki/Self-hosting_(web_services)), [federated](https://en.wikipedia.org/wiki/Federation_(information_technology)), [imageboard](https://en.wikipedia.org/wiki/Imageboard) platform that utilizes [ActivityPub](https://activitypub.rocks/).
# Server Installation and Configuration
@@ -10,10 +10,7 @@ _POST MINIMUM SERVER REQUIREMENTS HERE (OS, Hardware, etc.) HERE_
## Server Installation Instructions
-- Ensure you have golang installed at a correct
-```
-GOPATH
-```
+- Ensure you have golang installed at a correct `GOPATH`
- Copy `config-init` to `config` and change the values appropriately to reflect the instance.
@@ -27,16 +24,20 @@ GOPATH
_POST VARIOUS NOTABLE CONFIG OPTIONS THE HOST MAY WANT TO CHANGE IN CONFIGURATION, AS WELL AS ANY SECURITY SETTINGS HERE._
+## Server Update
+
+_PROVIDE INSTRUCTIONS FOR UPDATING THE SERVER TO THE LATEST VERSION HERE._
+
## Networking
### NGINX Template
-_PROVIDE A BASIC NGINX TEMPLATE HERE_
+_PROVIDE A BASIC NGINX TEMPLATE TWEAKED FOR FCHANNEL HERE_
### Apache
-_PROVIDE A BASIC APACHE TEMPLATE HERE_
+_PROVIDE A BASIC APACHE TEMPLATE TWEAKED FOR FCHANNEL HERE_
### Caddy
-_PROVIDE A BASIC CADDYv2 TEMPLATE HERE_ \ No newline at end of file
+_PROVIDE A BASIC CADDYv2 TEMPLATE TWEAKED FOR FCHANNEL HERE_