cyberpresidentvanellope/tgstation-server
1
0
Fork 0
mirror of https://github.com/tgstation/tgstation-server.git synced 2026-08-25 05:56:58 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update the readme

Browse Source
This commit is contained in:
Cyberboss
2017-10-21 21:36:57 -04:00
parent 754cb4a19a
commit 1722728ef3
1 changed files with 9 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+9 -3
View File
@@ -73,7 +73,7 @@ This process is identical to the above steps in command line mode. You can alway
1. Obtain an SSL certificate to secure the connection (this is beyond the scope of this guide)
1. Either stick with the default port `38607` or change it with `admin set-port <port #>`
1. [Bind the SSL certificate to port 38607](https://docs.microsoft.com/en-us/dotnet/framework/wcf/feature-details/how-to-configure-a-port-with-an-ssl-certificate)
1. [Bind the SSL certificate to the port](https://docs.microsoft.com/en-us/dotnet/framework/wcf/feature-details/how-to-configure-a-port-with-an-ssl-certificate)
- e.g. `netsh http add sslcert ipport=0.0.0.0:<port #> certhash=<certificate hash> appid={F32EDA25-0855-411C-AF5E-F0D042917E2D}`
- The `appid` GUID actually doesn't matter, but for sanity, you should use the GUID of TGServerService.exe as printed above
1. Ensure the port can be acccessed from the internet
@@ -97,6 +97,9 @@ The service supports updates while running a DreamDaemon instance. Simply instal
* This is a symbolic link pointing to current "live" folder.
* When the server is updated, we just point this to the updating folder so that the update takes place next round.
* `Diagnostics`
* This contains various timestamped diagnostic information for DreamDaemon invocations
* `Repository/`
* This contains the actual git repository, all changes in here will be overwritten during update operations.
@@ -118,6 +121,9 @@ The service supports updates while running a DreamDaemon instance. Simply instal
* `prtestjob.json`
* This contains information about current test merged pull requests in the Repository folder
* `TGS3.json`
* This is a copy of TGS3.json from the Repository. If a repostory change creates differences between the two, update operations will be blocked until the user confirms they want to change it
### Starting the game server:
To run the game server, open the `Server` tab of the control panel and click either `Start`
@@ -168,7 +174,7 @@ You can clear all active test merges using `Reset to Origin Branch` in the `Repo
### Viewing Server Logs
* Logs are stored in the Windows event viewer under `Windows Logs` -> `Application`. You'll need to filter this list for `TG Station Server`
* Every event type is keyed with an ID. A complete listing of these IDs can be found [here](https://github.com/tgstation/tgstation-server/blob/master/TGServerService/ServerService.cs#L15).
* Every event type is keyed with an ID. A complete listing of these IDs and their purpose can be found [here](https://github.com/tgstation/tgstation-server/blob/master/TGServerService/EventID.cs).
* You can also import the custom view `View TGS3 Logs.xml` in this folder to have them automatically filtered
### Enabling upstream changelog generation
@@ -180,7 +186,7 @@ You can clear all active test merges using `Reset to Origin Branch` in the `Repo
## CONTRIBUTING
* Version numbers and releases will be handled by maintainers, do not modify these in your PR
* See [CONTRIBUTING.md](https://github.com/tgstation/tgstation-server/.github/CONTRIBUTING.md)
## LICENSING