Updated Server Installation (markdown) authored by Robert Goldmann's avatar Robert Goldmann
...@@ -6,7 +6,27 @@ ...@@ -6,7 +6,27 @@
### Step 2: Put settings.json in same location ### Step 2: Put settings.json in same location
### Step 3: Create an empty mysql database ### Step 3a: Use a mysql database
- Create an empty mysql database
- Fill in the according lines in `settings.json`:
`"databaseType": "mysql",`
`"databaseUrl": "your_database_url_and_port",` (e.g. localhost:3306/)
`"databaseName": "your_database_name",`
`"databaseUsername": "your_database_user_name",`
`"databasePassword": "your_password"`
- proceed with step 4a or 4b
### Step 3b: Use a sqlite database
- Fill in the according lines in `settings.json`:
`"databaseType": "sqlite",`
`"databaseUrl": "save_path_for_the_database_file",`
___Note:__ If you don't provide a `"databaseURL"` the database file will be saved in the same location as BudgetMasterServer_
___Note:__ `"databaseName"`, `"databaseUsername"` and `"databasePassword"` are not relevant for sqlite_
- proceed with step 4a or 4b
### Step 4a: Use BudgetMasterServer in an local area network ### Step 4a: Use BudgetMasterServer in an local area network
If you are going to use the BudgetMasterServer in a local area network where it isn't exposed to the internet you could use the default certificate and keystore that comes bundled with the BudgetMasterServer. If you are going to use the BudgetMasterServer in a local area network where it isn't exposed to the internet you could use the default certificate and keystore that comes bundled with the BudgetMasterServer.
...@@ -19,14 +39,15 @@ This is definetly __NOT__ recommended as the certificate integrity and communica ...@@ -19,14 +39,15 @@ This is definetly __NOT__ recommended as the certificate integrity and communica
- Get a HTTPS certificate or create a self-signed one - Get a HTTPS certificate or create a self-signed one
_The communication between the server and client will be HTTPS-encrypted so you will need a certificate for the server._ _The communication between the server and client will be HTTPS-encrypted so you will need a certificate for the server._
- Create a Java Keystore holding your certificate - Create a Java Keystore holding your certificate
_[How to create a keystore from a certificate](https://github.com/deadlocker8/BudgetMaster/wiki/HTTPS)_ _[How to create a keystore from a certificate](https://github.com/deadlocker8/BudgetMaster/wiki/HTTPS)_
### Step 5: Fill in your settings into settings.json - fill in the corresponding lines in `settings.json`:
`"keystorePath": "path_to_keystore_file",`
`"keystorePassword": "your_keystore_password"`
### Step 6: Launch BudgetMasterServer.jar ### Step 5: Launch BudgetMasterServer.jar
all neccessary tables should be created automatically all neccessary tables should be created automatically
_Hint: If you encounter any problems or errors please have a look into the generated error.log in the same directory as the BudgetMasterServer.jar_ ___Hint:__ If you encounter any problems or errors please have a look into the generated error.log in the same directory as the BudgetMasterServer.jar_