aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorFChannel <>2021-05-30 14:01:01 -0700
committerFChannel <>2021-05-30 14:01:01 -0700
commit6413dd0fa2b3a381d306069ad8d2dd766fe754ec (patch)
treee3bfcfc6361368f83cf6dda91708daf7b3d25473 /README.md
parent30714d5e76a94947a49487f526e48a996f1d9eaa (diff)
removed Header Referer for re routing since it does not work for all browsers ie IceCat
Diffstat (limited to 'README.md')
-rw-r--r--README.md30
1 files changed, 6 insertions, 24 deletions
diff --git a/README.md b/README.md
index 05ff96b..8da0dd6 100644
--- a/README.md
+++ b/README.md
@@ -74,36 +74,18 @@ Any contributions or suggestions are appreciated. Best way to give immediate fee
`emailpass:password`
+#### local testing
+ When testing on a local env when setting the `instance` value in the config file you have to append the port number to the local address eg. `instance:localhost:3000` with `instanceport` also being set to the same port.
+
+ If you want to test federation between servers locally you have to use your local ip as the `instance` eg. `instance:192.168.0.2:3000` and `instance:192:168:0:3:3000` adding the port to localhost will not route correctly.
+
### Managing the server
To access the managment page to create new boards or subscribe to other boards, when you start the server the console will output the `Mod key` and `Admin Login`
Use the `Mod key` by appending it to your servers url, `https://fchan.xyz/[Mod key]` once there you will be prompted for the `Admin Login` credentials.
- You can manage each board by appending the `Mod key` to the desired board url: `https://fchan.xyz/g/[Mod Key]`
+ You can manage each board by appending the `Mod key` to the desired board url: `https://fchan.xyz/[Mod Key]/g`
The `Mod key` is not static and is reset on server restart.
-### Creating a new board
-
- `CreateNewBoardDB(db *sql.DB, actor Actor)`
-
- returns Actor.
-
-### Creating a new actor
-
- `CreateNewActor(board string, prefName string, summary string, authReq []string, restricted bool)`
-
- returns Actor
-
- - `board` is the abbreviated name such as `g`
-
- - `prefName` is the fully readable name such as `Technology`
-
- - `summary` is a summary of the board
-
- - `authReq` is an array string of required privileges to post on the board, default is: `[]string{"captcha","email","passphrase"}`
-
- - `restricted` is bool. `true` is blue board, `false` is red board
-
-
## Server Update
Check the git repo for the latest commits. If there are commits you want to update to, pull and restart instance.