Skip to content

Commit

Permalink
Update README to add MelonMesa's CentCom server
Browse files Browse the repository at this point in the history
  • Loading branch information
bobbah authored Jul 30, 2020
1 parent 509816f commit 30c4c55
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# CentCom
CentCom is a software suite used to provide a global bans database for Space Station 13. It is capable of ingesting data from several public ban lists, and provides an API through which to search these collected records.

**There is a central instance of CentCom running at https://centcomm.melonmesa.com, where you can also find the compiled Swagger documentation to read about and experiment with the API.**

## Setup
To run your own local instance of CentCom, you must have the following...
- A supported database to store the ban data within (Postgres, MySql, MariaDB). You will need to create a database for the CentCom data, and users for the parsing server and API server.
Expand Down Expand Up @@ -46,4 +48,4 @@ Add-Migration -Context MySqlDbContext -OutputDir Migrations/MySql <Name of migra

### Adding a New Database Backend

If you wish to support an additional database backend, you will need to create a new subclass of ``CentCom.Common.Data.DatabaseContext``. If necessary, you can overload how model types are stored in the new database backend by providing an override for the ``OnModelCreating`` method of ``DatabaseContext``, which you can see an example of in ``CentCom.Common.Data.MySqlDbContext``. As well as this, you will need to add a migration for your new database backend. You can do so using the same format as found in '*Making Changes to Database Objects*' above.
If you wish to support an additional database backend, you will need to create a new subclass of ``CentCom.Common.Data.DatabaseContext``. If necessary, you can overload how model types are stored in the new database backend by providing an override for the ``OnModelCreating`` method of ``DatabaseContext``, which you can see an example of in ``CentCom.Common.Data.MySqlDbContext``. As well as this, you will need to add a migration for your new database backend. You can do so using the same format as found in '*Making Changes to Database Objects*' above.

0 comments on commit 30c4c55

Please sign in to comment.