From 057e0ab1f4064e70bd9bcb0370a0c2d5e23e0789 Mon Sep 17 00:00:00 2001 From: john <18413674+grravity@users.noreply.github.com> Date: Thu, 1 Apr 2021 19:22:52 +0000 Subject: Added sections, plus spaces to fill in missing info --- README.md | 43 +++++++++++++++++++++++++++++++++++-------- 1 file changed, 35 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index fb9b28b..0bb6e35 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,42 @@ -Setup: +# About -Have golang installed a correct GOPATH +FChannel is a libre, self-hostable, federated, imageboard platform that utilizes ActivittPub. -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._ + +## Networking + +### NGINX Template + +_PROVIDE A BASIC NGINX TEMPLATE HERE_ + +### Apache + +_PROVIDE A BASIC APACHE TEMPLATE HERE_ + +### Caddy + +_PROVIDE A BASIC CADDYv2 TEMPLATE HERE_ \ No newline at end of file -- cgit v1.2.3