mirror of
https://github.com/spacebarchat/server.git
synced 2024-11-05 10:22:31 +01:00
Add back various docs/readme
This commit is contained in:
parent
0957917ba2
commit
2771e06166
@ -1,3 +1,5 @@
|
||||
assets
|
||||
dist
|
||||
node_modules
|
||||
node_modules
|
||||
.github
|
||||
.vscode
|
30
README.md
30
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.
|
||||
<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/)
|
15
env-vars.md
Normal file
15
env-vars.md
Normal file
@ -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 |
|
26
nginx.conf
Normal file
26
nginx.conf
Normal file
@ -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";
|
||||
}
|
||||
}
|
Loading…
Reference in New Issue
Block a user