Releases: OpenShock/API
2.4.0
2.4.0
- Reworked signup, login and password logic into AccountService
- Changed password encryption from PBKDF2 to BCrypt Enhanced SHA512
- Changed password reset encryption to the same
- Preparation for Email verification
2.3.0
2.3.0
Breaking Changes
- Reworked the entire Email system, check the README.md for the Config parameters
- Reworked the OpenAPI docs operationIds again
2.2.0
2.2.0
- Adjusted Swagger OperationIds
2.1.1
2.1.1
- Fixed an issue where trying to connect to a live control websocket of a shared shocker would error
2.1.0
2.0.0
2.0.0
- OTA device updates
- Live Control features and LiveControlGateway is now needed
- Smaller fixes and improvements to code quality
1.8.2
OpenShock API
OpenShock backend.
Configuration
The API can be configured using the following environment variables:
Variable | Default value | Example value |
---|---|---|
OPENSHOCK__DB |
Host=docker-node;Port=1337;Database=root;Username=root;Password=root;Search Path=openshock |
|
OPENSHOCK__FRONTENDBASEURL |
https://shocklink.net |
https://shocklink.net |
OPENSHOCK__REDIS__HOST |
x | redis |
OPENSHOCK__REDIS__PORT |
6379 |
|
OPENSHOCK__REDIS__USER |
||
OPENSHOCK__REDIS__PASSWORD |
||
OPENSHOCK__MAILJET__KEY |
||
OPENSHOCK__MAILJET__SECRET |
Deployment
The OpenShock stack consists of the following components:
- Postgres as database
- Redis
- The API (this repository)
- The WebUI
Using Docker
Assuming you have all other required containers running (if not, see above), you can run the following command to start
the API:
docker run \
ghcr.io/shock-link/api:latest \
--name shocklink-api \
-e OPENSHOCK__DB=Host=docker-node;Port=1337;Database=root;Username=root;Password=root;Search Path=openshock \
-e OPENSHOCK__REDIS__HOST=localhost \
-e OPENSHOCK__FRONTENDBASEURL=https://myopenshock.app \
-p 80:80/tcp
Using docker-compose
See docker-compose.yml.
Current struggles
- Dependency with Mailjet templates
1.8.1
OpenShock API
OpenShock backend.
Configuration
The API can be configured using the following environment variables:
Variable | Default value | Example value |
---|---|---|
OPENSHOCK__DB |
Host=docker-node;Port=1337;Database=root;Username=root;Password=root;Search Path=openshock |
|
OPENSHOCK__FRONTENDBASEURL |
https://shocklink.net |
https://shocklink.net |
OPENSHOCK__REDIS__HOST |
x | redis |
OPENSHOCK__REDIS__PORT |
6379 |
|
OPENSHOCK__REDIS__USER |
||
OPENSHOCK__REDIS__PASSWORD |
||
OPENSHOCK__MAILJET__KEY |
||
OPENSHOCK__MAILJET__SECRET |
Deployment
The OpenShock stack consists of the following components:
- Postgres as database
- Redis
- The API (this repository)
- The WebUI
Using Docker
Assuming you have all other required containers running (if not, see above), you can run the following command to start
the API:
docker run \
ghcr.io/shock-link/api:latest \
--name shocklink-api \
-e OPENSHOCK__DB=Host=docker-node;Port=1337;Database=root;Username=root;Password=root;Search Path=openshock \
-e OPENSHOCK__REDIS__HOST=localhost \
-e OPENSHOCK__FRONTENDBASEURL=https://myopenshock.app \
-p 80:80/tcp
Using docker-compose
See docker-compose.yml.
Current struggles
- Dependency with Mailjet templates
1.8.0
OpenShock API
OpenShock backend.
Configuration
The API can be configured using the following environment variables:
Variable | Default value | Example value |
---|---|---|
OPENSHOCK__DB |
Host=docker-node;Port=1337;Database=root;Username=root;Password=root;Search Path=openshock |
|
OPENSHOCK__FRONTENDBASEURL |
https://shocklink.net |
https://shocklink.net |
OPENSHOCK__REDIS__HOST |
x | redis |
OPENSHOCK__REDIS__PORT |
6379 |
|
OPENSHOCK__REDIS__USER |
||
OPENSHOCK__REDIS__PASSWORD |
||
OPENSHOCK__MAILJET__KEY |
||
OPENSHOCK__MAILJET__SECRET |
Deployment
The OpenShock stack consists of the following components:
- Postgres as database
- Redis
- The API (this repository)
- The WebUI
Using Docker
Assuming you have all other required containers running (if not, see above), you can run the following command to start
the API:
docker run \
ghcr.io/shock-link/api:latest \
--name shocklink-api \
-e OPENSHOCK__DB=Host=docker-node;Port=1337;Database=root;Username=root;Password=root;Search Path=openshock \
-e OPENSHOCK__REDIS__HOST=localhost \
-e OPENSHOCK__FRONTENDBASEURL=https://myopenshock.app \
-p 80:80/tcp
Using docker-compose
See docker-compose.yml.
Current struggles
- Dependency with Mailjet templates
1.7.1
OpenShock API
OpenShock backend.
Configuration
The API can be configured using the following environment variables:
Variable | Default value | Example value |
---|---|---|
OPENSHOCK__DB |
Host=docker-node;Port=1337;Database=root;Username=root;Password=root;Search Path=openshock |
|
OPENSHOCK__FRONTENDBASEURL |
https://shocklink.net |
https://shocklink.net |
OPENSHOCK__REDIS__HOST |
x | redis |
OPENSHOCK__REDIS__PORT |
6379 |
|
OPENSHOCK__REDIS__USER |
||
OPENSHOCK__REDIS__PASSWORD |
||
OPENSHOCK__MAILJET__KEY |
||
OPENSHOCK__MAILJET__SECRET |
Deployment
The OpenShock stack consists of the following components:
- Postgres as database
- Redis
- The API (this repository)
- The WebUI
Using Docker
Assuming you have all other required containers running (if not, see above), you can run the following command to start
the API:
docker run \
ghcr.io/shock-link/api:latest \
--name shocklink-api \
-e OPENSHOCK__DB=Host=docker-node;Port=1337;Database=root;Username=root;Password=root;Search Path=openshock \
-e OPENSHOCK__REDIS__HOST=localhost \
-e OPENSHOCK__FRONTENDBASEURL=https://myopenshock.app \
-p 80:80/tcp
Using docker-compose
See docker-compose.yml.
Current struggles
- Dependency with Mailjet templates