History

Oliver-Akins 48e2ae15f8 Add setup instructions for the server		2021-01-09 01:54:11 -07:00
..
docs	Update doc for SendCard	2020-12-27 15:12:05 -07:00
resources	Add CSV files to the resources directory	2021-01-01 15:53:41 -07:00
src	Emit event to all clients in game not just writers	2021-01-09 00:17:44 -07:00
package.json	Add neat-csv to packages.	2021-01-03 16:36:55 -07:00
pnpm-lock.yaml	Add neat-csv to packages.	2021-01-03 16:36:55 -07:00
README.md	Add setup instructions for the server	2021-01-09 01:54:11 -07:00
template.toml	Update log level default to be info instead of silly.	2021-01-09 01:30:09 -07:00
tsconfig.json	Change tsc build file	2020-12-24 21:47:17 -07:00

README.md

Setup:

cd into this server directory.
Run pnpm install to install all of the required dependencies.
Create a copy of the template.toml file, and name it server.toml.
Edit the server.toml file to adjust the
Run tsc to compile the TypeScript into Javascript. This should create a dist directory.

Using systemd to manage the server: (Not currently implemented)

This app comes with a ghost-writer.service file which is already set up to manage the server, it just requires a little bit of additional setup. If you change any of the symlinking in the steps below, it is your responsibility to figure it out, I will not guarantee support for people who attempt to modify the service file.

Create a symlink named server in the server root (/) pointing to the server folder in the Ghost Writer git repository. (Ex: sudo ln -s ~/Ghost-Writer-Online/server /server)
Create a symlink named ghost-writer.service in / pointing to the service file in the server folder of the Ghost Writer Online repository. (Ex: sudo ln -s //ghost-writer.service /server/ghost-writer.service)
Run sudo systemctl enable ghost-writer to tell systemd to use that service
Start the websocket server with sudo systemctl start ghost-writer.
Make sure the server is started by running systemctl status ghost-writer

To restart the server, run sudo systemctl restart ghost-writer.
To stop the server, run sudo systemctl stop ghost-writer.
To access the server logs, run journalctl

Using a detached terminal:

If you would prefer that the server does not automatically restart and you can more easily output log output to a file, you can run the server by following the below steps:

Make sure you know how to invoke a single command with your preferred method of detaching terminals.
Have the detached terminal's working directory be in the server folder of this repository.
Run node dist/main.js for logging directly to the CLI, or node dist/main.js > output.log for logging to a file named output.log.
Detach your terminal.