JWT symmetric keys #77
@@ -37,32 +37,27 @@ One can interface with Icarus the music server either by:
|
||||
## Getting started
|
||||
|
||||
There are several things that need to be completed to properly setup and secure the API.
|
||||
1. Creating RSA keys
|
||||
#### 1. Creating RSA keys
|
||||
1. JWT Information
|
||||
2. API filesystem paths
|
||||
3. Database connection string
|
||||
4. Migrations
|
||||
|
||||
|
||||
### Creating RSA keys
|
||||
### JWT Information
|
||||
|
||||
1. Create private key
|
||||
```
|
||||
openssl genrsa -out private.pem 2048
|
||||
```
|
||||
2. Create public key
|
||||
```
|
||||
openssl rsa -in private -pubout -out public.pem
|
||||
```
|
||||
|
||||
Configure the key paths in the config files
|
||||
Configure JWT information. Notably the Secret
|
||||
|
||||
```Json
|
||||
"RSAKeys": {
|
||||
"PrivateKeyPath": "",
|
||||
"PublicKeyPath": ""
|
||||
}
|
||||
"JWT": {
|
||||
"Issuer": "IcarusAPI",
|
||||
"Audience": "IcarusAPIClient",
|
||||
"Secret": "X1I9TbwaBG3RiwLiCJ69lHGxLFoNODDE",
|
||||
"Subject": "Authorization"
|
||||
},
|
||||
```
|
||||
|
||||
|
||||
Replace [domain] with the domain name that represent's your domain. Replace [identifier] with the identifer root name in the appsettings environment file. Not the friendly name but the root name of the identifier, omitting the http protocol and the *api* path.
|
||||
|
||||
```Json
|
||||
@@ -72,6 +67,9 @@ Replace [domain] with the domain name that represent's your domain. Replace [ide
|
||||
},
|
||||
```
|
||||
|
||||
**Note**: The Auth0 section is likely to be changed or removed in future releases.
|
||||
|
||||
|
||||
### API filesystem paths
|
||||
|
||||
For the purposes of properly uploading, downloading, updating, deleting, and streaming songs the API filesystem paths must be configured. What is meant by this is that the `RootMusicPath` directory where all music will be stored must exist as well as the `ArchivePath` and `TemporaryMusicPath` paths. An example on a Linux system:
|
||||
|
||||
Reference in New Issue
Block a user