summary refs log tree commit diff
diff options
context:
space:
mode:
authorMadeline <46743919+MaddyUnderStars@users.noreply.github.com>2022-12-19 22:48:25 +1100
committerMadeline <46743919+MaddyUnderStars@users.noreply.github.com>2022-12-19 22:48:25 +1100
commitec5807723be94a8b9945891a41d7ebb75555146f (patch)
tree981c80452b8c86d9269c7553914d7b85e7e85b22
parentReg tokens bypass other restrictions (diff)
downloadserver-ec5807723be94a8b9945891a41d7ebb75555146f.tar.xz
Add back various docs/readme
-rw-r--r--.prettierignore4
-rw-r--r--README.md30
-rw-r--r--env-vars.md15
-rw-r--r--nginx.conf26
4 files changed, 71 insertions, 4 deletions
diff --git a/.prettierignore b/.prettierignore
index b36ef3a2..51116757 100644
--- a/.prettierignore
+++ b/.prettierignore
@@ -1,3 +1,5 @@
 assets
 dist
-node_modules
\ No newline at end of file
+node_modules
+.github
+.vscode
\ No newline at end of file
diff --git a/README.md b/README.md
index 73583017..59a0388e 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,30 @@
 <p align="center">
-	<img width="100" src="https://raw.githubusercontent.com/fosscord/fosscord/master/assets-rebrand/svg/Fosscord-Icon-Rounded-Subtract.svg"/>
+  <img width="100" src="https://raw.githubusercontent.com/fosscord/fosscord/master/assets-rebrand/svg/Fosscord-Icon-Rounded-Subtract.svg" />
 </p>
-<h1 align="center">Fosscord</h1>
+<h1 align="center">Fosscord Server</h1>
 
-This branch is for MaddyUnderStars' refactor of Fosscord. This is not ready for production use.
\ No newline at end of file
+<p align="center">
+  <a href="https://discord.gg/ZrnGQP6p3d">
+    <img src="https://img.shields.io/discord/806142446094385153?color=7489d5&logo=discord&logoColor=ffffff" />
+  </a>
+  <img src="https://img.shields.io/static/v1?label=Status&message=Development&color=blue">
+  <a title="Crowdin" target="_blank" href="https://translate.fosscord.com/"><img src="https://badges.crowdin.net/fosscord/localized.svg"></a>
+   <a href="https://opencollective.com/fosscord">
+    <img src="https://opencollective.com/fosscord/tiers/badge.svg">
+  </a>
+</p>
+
+## [About](https://fosscord.com)
+
+This repository contains:
+
+-   [Fosscord HTTP API Server](/src/api)
+-   [WebSocket Gateway Server](/src/gateway)
+-   [HTTP CDN Server](/src/cdn)
+-   [Utility and Database Models](/src/util)
+
+## [Resources](https://docs.fosscord.com/resources/)
+
+-   [Contributing](https://docs.fosscord.com/contributing/server/)
+
+## [Setup](https://docs.fosscord.com/server/setup/)
\ No newline at end of file
diff --git a/env-vars.md b/env-vars.md
new file mode 100644
index 00000000..42e8a027
--- /dev/null
+++ b/env-vars.md
@@ -0,0 +1,15 @@
+# Fosscord env vars:
+
+| Name             | Value          | Description                                                     |
+| ---------------- | -------------- | --------------------------------------------------------------- |
+| THREADS          | number         | Number of threads to run Fosscord on when using bundle.         |
+| PORT             | number         | Port to listen on                                               |
+| DATABASE         | string         | Database connection string. Defaults to SQlite3 at project root |
+| CONFIG_PATH      | string         | File path for JSON config, if not using `config` db table       |
+| WS_LOGEVENTS     | boolean        | If set, log websocket events from gateway                       |
+| CDN              | string         | Lowest priority value for public CDN annoucements               |
+| GATEWAY          | string         | Lowest priority value for public gateway annoucements           |
+| STORAGE_LOCATION | string         | CDN storage location. File path or S3 bucktet                   |
+| STORAGE_PROVIDER | "s3" or "file" | CDN storage provider                                            |
+| STORAGE_BUCKET   | string         | S3 bucket name                                                  |
+| STORAGE_REGION   | string         | S3 storage region                                               |
diff --git a/nginx.conf b/nginx.conf
new file mode 100644
index 00000000..141cf5ca
--- /dev/null
+++ b/nginx.conf
@@ -0,0 +1,26 @@
+# This is an example nginx config for Fosscord.
+
+server {
+	# Change server_name
+    server_name fosscord.example.com;
+    listen 80;
+
+    location / {
+			# do NOT change this
+            proxy_pass http://127.0.0.1:3001; 
+            proxy_set_header Host $host;
+            proxy_pass_request_headers      on;
+            add_header Last-Modified $date_gmt;
+            add_header Cache-Control 'no-store, no-cache, must-revalidate, proxy-revalidate, max-age=0';
+            proxy_set_header  X-Real-IP $remote_addr;
+            proxy_set_header  X-Forwarded-Proto https;
+            proxy_set_header  X-Forwarded-For $remote_addr;
+            proxy_set_header  X-Forwarded-Host $remote_addr;
+            proxy_no_cache 1;
+            proxy_cache_bypass 1;
+
+			# this is important
+            proxy_set_header Upgrade $http_upgrade;
+            proxy_set_header Connection "upgrade";
+    }
+}
\ No newline at end of file