LicenseServer/README.md

66 lines
1.3 KiB
Markdown
Raw Normal View History

2023-05-30 17:39:36 -07:00
# LicenseServer
2023-05-31 22:17:13 -07:00
A simple open-source licensing server for your products.
2023-05-31 22:29:21 -07:00
## Discord Preview
2023-06-01 21:42:51 -07:00
![License Global Log](https://cdn.rainnny.club/SagsCD0I.png)
![License Owner Log](https://cdn.rainnny.club/JZdFxTCy.png)
2023-05-31 22:29:21 -07:00
2023-05-31 22:17:13 -07:00
## API Reference
### Check License
```http
2023-05-31 22:21:15 -07:00
POST /check
2023-05-31 22:17:13 -07:00
```
#### Body
| Key | Type | Description |
|:----------|:---------|:-----------------------------------------------|
| `key` | `string` | **Required**. Your license key |
| `product` | `string` | **Required**. The product the license is for |
| `hwid` | `string` | **Required**. The hardware id of the requester |
2023-05-31 22:23:12 -07:00
#### Response
##### Error
```json
{
"error": "Error message"
}
```
##### Success
```json
{
"description": "Testing",
"ownerSnowflake": 504147739131641857,
"ownerName": "Braydon#2712",
2023-06-01 21:44:10 -07:00
"expires": "2023-06-02T06:00:47.270+00:00"
2023-05-31 22:23:12 -07:00
}
```
2023-05-31 22:17:13 -07:00
## Deployment
### Docker
```bash
docker run -d -p 7500:7500 -v "$(pwd)/data/application.yml:/usr/local/app/application.yml" git.rainnny.club/rainnny/licenseserver:latest
2023-05-31 22:17:13 -07:00
```
### Docker Compose
```yml
version: '3'
services:
app:
image: git.rainnny.club/rainnny/licenseserver:latest
volumes:
- ./data/application.yml:/usr/local/app/application.yml
2023-05-31 22:17:13 -07:00
ports:
- "7500:7500"
```