Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
rodrigue10 committed Oct 21, 2021
2 parents a325ded + 883492d commit 4c7b300
Showing 1 changed file with 12 additions and 6 deletions.
18 changes: 12 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,26 +13,32 @@ Ultimately this has been a vehicle to help me learn and solidify my development

## Pre-Requisites
- The explorer needs a Signum Node that uses a MariaDB backend (NO H2 file DB support)
- Addition of Indexes and Views to the DB
- Addition of Indexes and Views to the DB (Currently managed by the application and these should be added upon startup so long as your connection strings are setup correctly.)
- Access to your MariaDB Signum DB as needed based on how your deploying the application. (Firewall, and DB GRANT permissions setup.)
- For Windows, IIS is the preferred way to deploy, however the application can be run on it's own as long as you are able to configure your webserver/proxy redirect to point to the appropriate port.
- This is meant to run as a Blazor SERVER application. Because of this it uses a "Signal-R" connection, which is essentially WebSockets. Make sure you're setup for this when trying to access the site from outside your local network.
- For Linux, I have not been able to try this yet. Will know more once i try to deploy there.
- This is meant to run as a Blazor SERVER application. Because of this it uses a "Signal-R" connection, which is essentially an abstraction over WebSockets. Make sure you're setup for this when trying to access the site from outside your local network via any reverse proxy/web server you have setup.

### MariaDB Views and Indexes
Your DB will need some additional Views and Indexes added. This is a manual process at this
This should be automated now. Scripts included for reference purposes.
~~Your DB will need some additional Views and Indexes added. This is a manual process at this
time so using your DB access tool of choice you will find a series of `.sql` scripts for Views and Indexes located here:
[DB Scripts](https://github.com/rodrigue10/SignumExplorer/tree/master/SignumExplorer/DB%20scripts) . These scripts will add necessary views to allow the explorer to function properly.
[DB Scripts](https://github.com/rodrigue10/SignumExplorer/tree/master/SignumExplorer/DB%20scripts) . These scripts will add necessary views to allow the explorer to function properly.~~

### Configuration.
There are a couple files that will help configure the connection strings that are needed to connect to your MariaDB.
`appsettings.json` and `appsettings.production.json` .

The main areas of concern are `SRSConnection` and `MariaDBSettings`. These are the areas to input the connection string to allow the app to connect to the Signum Node DB, and the other is for defining the MariaDB version that you are using. Stick the the format in the files and replace the information needed to match your environment.
The main areas of concern in these files are as follows and stick the the format in the files to replace the information needed to match your environment.:
- `SRSConnection` - Signum Node Connection String
- `ExplorerConnection` - Explorer DB Connection String (You won't have a DB setup for this. The app will create it for you as long as the connection string is setup
- `MariaDBSettings` - Define the MariaDB version that you are using (Recommend using version 10.6 as this is what i've built it with, however >10.3 is likely to work without any issues).

```json
"ConnectionStrings": {
"SQLiteConnection": "Data Source=SignumExplorerDB.db",
"SRSConnection": "server=srs-node-pool;user=signum;password=signumpassword;database=signum"
"SRSConnection": "server=srs-node-pool;user=signum;password=signumpassword;database=signum",
"ExplorerConnection": "server=srs-node-pool;user=signum;password=signumpassword;database=explorer"
},
"MariaDBSettings": {
"Version": "10.6.4-mariadb"
Expand Down

0 comments on commit 4c7b300

Please sign in to comment.