velvox
/
litecord
mirror of https://gitlab.com/litecord/litecord.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

README: add "Checking if it is working" section 

Related to #18.
This commit is contained in:
Luna Mendes 2018-11-15 18:08:12 -03:00
parent 02d37091a7
commit 5f9e04b866
2 changed files with 15 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -55,6 +55,15 @@ Use `--access-log -` to output access logs to stdout.
$ pipenv run hypercorn run:app $ pipenv run hypercorn run:app
``` ```
*It is recommended to run litecord behind NGINX.* Because of that,
there is a basic `nginx.conf` file at the root.
### Checking if it is working
You can check if your instance is running by checking the `/api/v6/gateway`
path. And for basic websocket testing a tool such as [wss](https://github.com/hashrocket/ws)
can be used.
## Updating ## Updating
```sh ```sh

8
nginx.conf
View File

@ -1,6 +1,10 @@
# Main litecord HTTP proxy. # litecord nginx file
# this file is not considering any https happening,
# those are manual and up to the instance owner.
server { server {
server_name main.somewhere; server_name example.tld;
location / { location / {
proxy_pass http://localhost:5000; proxy_pass http://localhost:5000;