aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFChannel0 <77419041+FChannel0@users.noreply.github.com>2021-04-08 23:45:25 -0700
committerGitHub <noreply@github.com>2021-04-08 23:45:25 -0700
commitada1cc89a6c6d329d6fc059040c851ea2776e10c (patch)
tree16eb835c9d0f727d4bd92a6ea9dd4270c13bc068
parent7ea1b2b642569e34cc860a9adbfe70e6299c4ed7 (diff)
parent408eb81a7b45ebd33cd2d89ab07c3047fa2e23b2 (diff)
Merge pull request #4 from grravity/master
Improved Docs, Left Spaces To Fill In Info
-rw-r--r--README.md44
1 files changed, 36 insertions, 8 deletions
diff --git a/README.md b/README.md
index fb9b28b..1e2621a 100644
--- a/README.md
+++ b/README.md
@@ -1,15 +1,43 @@
-Setup:
+# About
-Have golang installed a correct GOPATH
+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/).
-Copy config-init to config and change the values to reflect the instance
+# Server Installation and Configuration
-Create the database, username, and password for psql that is used in config file
+## Minimum Server Requirements
-run
+_POST MINIMUM SERVER REQUIREMENTS HERE (OS, Hardware, etc.) HERE_
-psql -U (user) -d (database) -f databaseschema.psql
+## Server Installation Instructions
-then start the server with
+- Ensure you have golang installed at a correct `GOPATH`
-go run . \ No newline at end of file
+- Copy `config-init` to `config` and change the values appropriately to reflect the instance.
+
+- Create the database, username, and password for psql that is used in config file.
+
+- Run `psql -U (user) -d (database) -f databaseschema.psql`
+
+- Finally start the server with `go run`.
+
+## Server Configuration
+
+_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 TWEAKED FOR FCHANNEL HERE_
+
+### Apache
+
+_PROVIDE A BASIC APACHE TEMPLATE TWEAKED FOR FCHANNEL HERE_
+
+### Caddy
+
+_PROVIDE A BASIC CADDYv2 TEMPLATE TWEAKED FOR FCHANNEL HERE_