Swordsteel
0c063c3f5c
- update release in README.md - add action run checks - add action release - remove release.sh
52 lines
2.4 KiB
Markdown
52 lines
2.4 KiB
Markdown
# Hlæja Management
|
|
|
|
In realms of connectedness, where devices roam free, A nexus of management, harmony to decree. Each gadget configured, with precision and care, Their settings aligned, with purpose to share. From networks to endpoints, unity is key, Administrators and users, their access to see. The Device Dominion, a hub of control, A registry of configurations, where order makes whole.
|
|
|
|
## Properties for deployment
|
|
|
|
| name | required | info |
|
|
|----------------------------|:--------:|-------------------------|
|
|
| spring.profiles.active | ✓ | Spring Boot environment |
|
|
| spring.cache.type | | Cache type (redis) |
|
|
| spring.data.redis.host | ✓ | Redis host |
|
|
| spring.data.redis.port | | Redis port |
|
|
| spring.data.redis.database | ✓ | Redis database |
|
|
| spring.data.redis.password | ✗ | Redis password |
|
|
| jwt.public-key | ✓ | JWT public key file |
|
|
| account-registry.url | ✓ | Account Register URL |
|
|
| device-registry.url | ✓ | Device Register URL |
|
|
|
|
*Required: ✓ can be stored as text, and ✗ need to be stored as secret.*
|
|
|
|
## Releasing Service
|
|
|
|
Run release pipeline from `master` branch.
|
|
|
|
## Development Information
|
|
|
|
### Public RSA Key
|
|
|
|
This service uses the public key from **[Hlæja Account Register](https://github.com/swordsteel/hlaeja-account-registry)** to identify users. To set up user identification for local development, copy the `public_key.pem` file from the `./cert` directory in **Hlæja Account Register** into the `./cert` directory of this project.
|
|
|
|
*Note: For more information on generating RSA keys, please refer to our [generate RSA key](https://github.com/swordsteel/hlaeja-development/blob/master/doc/rsa_key.md) documentation.*
|
|
|
|
### Global Setting
|
|
|
|
The following global settings are used in Hlaeja Device Registry. You can configure these settings using either Gradle properties or alternatively environment variables.
|
|
|
|
*For instructions on how to set these up, please refer to our [set global settings](https://github.com/swordsteel/hlaeja-development/blob/master/doc/global_settings.md) documentation.*
|
|
|
|
#### Gradle Properties
|
|
|
|
```properties
|
|
repository.user=your_user
|
|
repository.token=your_token_value
|
|
```
|
|
|
|
#### Environment Variables
|
|
|
|
```properties
|
|
REPOSITORY_USER=your_user
|
|
REPOSITORY_TOKEN=your_token_value
|
|
```
|