https://github.com/bekk/db-scheduler-ui
https://github.com/bekk/db-scheduler-ui
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/bekk/db-scheduler-ui
- Owner: bekk
- License: apache-2.0
- Created: 2023-08-10T11:57:41.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-09-03T10:25:56.000Z (8 months ago)
- Last Synced: 2026-01-14T04:45:38.233Z (3 months ago)
- Language: Java
- Size: 2.52 MB
- Stars: 72
- Watchers: 6
- Forks: 23
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome - bekk/db-scheduler-ui - (<a name="Java"></a>Java)
README
# DB Scheduler UI
[](http://www.apache.org/licenses/LICENSE-2.0.html)
A UI extension for [db-scheduler](https://github.com/kagkarlsson/db-scheduler) that provides a browser accessible
dashboard for monitoring and basic administration of tasks.
## Features
* **View tasks** that are Scheduled, Running or Failed.
* **Re-run or Run** your task directly from the User Interface
* **Delete tasks**
* **Uses SpringBoot** to launch a UI
* **View the history of all tasks** (optional)
## Table of contents
* [Getting started](#getting-started)
* [Prerequisites](#prerequisites)
* [How it works](#how-it-works)
* [Configuration](#configuration)
### Prerequisites
* An existing Spring Boot application, with [db-scheduler](https://github.com/kagkarlsson/db-scheduler)
* Minimum db-scheduler version 15
* Minimum Java 17 and SpringBoot 3.3
* Optional (if you want task history): db-scheduler-log version 0.7.0
## Getting started
1. Add the db-scheduler-ui spring boot starter maven dependency
```xml
no.bekk.db-scheduler-ui
db-scheduler-ui-starter
4.3.0
```
2. Read the [db-scheduler](https://github.com/kagkarlsson/db-scheduler) readme and follow the getting started guide. The
most important is to create the `scheduled_tasks` table correctly.
You do not need to add db-scheduler as a dependency.
3. Start your application. The db-scheduler UI can be reached at `/db-scheduler`
## Optional: task history
If you want to add task history to your UI you need to add the following dependency:
```xml
io.rocketbase.extension
db-scheduler-log-spring-boot-starter
0.7.0
```
Follow the [readme](https://github.com/rocketbase-io/db-scheduler-log) to create the correct database table.
You also need to set `db-scheduler-ui.history=true` in your application.properties file, and consider setting a limit to
the number of logs fetched: `db-scheduler-ui.log-limit=1000`.
## How it works
db-scheduler-ui adds a REST-api package that has a bundled frontend application.
Springboot is used to configure beans and handle dependencies within the library and your application.
The user interface makes calls to the scheduler-client, where it can fetch, delete, run, and reschedule tasks.
These tasks are then shown in the web application.
An optional log module can also be added, making it possible to view the history of all your task executions.
## Configuration
db-scheduler-ui can be configured using the following options:
`history`: Turns on db-scheduler-log, default value is `false`. You can also limit the number of logs to fetch
with `log-limit`.
```
db-scheduler-ui.history=true
db-scheduler-ui.log-limit=1000
```
If you for some reason want to hide the task data you can set this to false. defaults to `true`
```
db-scheduler-ui.task-data=false
```
Or if you want a _read-only_ mode (in which tasks cannot be manually run, deleted or scheduled) set `read-only` to `true`, defaults to `false`
````
db-scheduler-ui.read-only=true
````
If you want to add a _prefix_ for the ui you can set the property below.
````
db-scheduler-ui.context-path=prefix
````
## Security
In case you want to secure db-scheduler-ui you can use [Spring Security](https://spring.io/projects/spring-security), you should secure the paths `/db-scheduler` and `/db-scheduler-api`.
In a more advanced scenario, you could assign an _admin role_ and a _read-only user_ role.
An example _filter chain_ with basic security:
```java
@Bean
SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
return http
.csrf(CsrfConfigurer::disable)
.authorizeHttpRequests(
authz ->
authz
// protect the UI
.requestMatchers("/db-scheduler/**").hasAnyRole("ADMIN", "USER")
// allow read access to the API for both users and admins
.requestMatchers(HttpMethod.GET, "/db-scheduler-api/**").hasAnyRole("ADMIN", "USER")
// only admins can delete tasks, alter scheduling, ...
.requestMatchers(HttpMethod.POST, "/db-scheduler-api/**").hasAnyRole("ADMIN")
// other application specific security
.anyRequest().permitAll())
.httpBasic(withDefaults())
.build();
}
```
additionally you might want to hide delete, run, ... buttons in the UI. To achieve this, declare the following bean:
```java
@Bean
ConfigController configController(DbSchedulerUiProperties properties) {
return new ConfigController(properties.isHistory(), readOnly(properties));
}
private Supplier readOnly(DbSchedulerUiProperties properties) {
// either global readonly mode is active or user has no admin rights
return () -> properties.isReadOnly() || !isAdmin();
}
private boolean isAdmin() {
Authentication auth = SecurityContextHolder.getContext().getAuthentication();
if (auth == null) {
return false;
}
return auth.getAuthorities().stream().anyMatch(a -> "ROLE_ADMIN".equals(a.getAuthority()));
}
```
## Contributing
Feel free to create pull requests if there are features or improvements you want to add.
PR's need to be approved by one of the maintainers. To publish a new version, create a release in Github and tag it with
a SemVer version.
A new release will then be released to maven central by a github action using JReleaser.
Before submitting a PR make sure to run `mvn spotless:apply` to format the code correctly.
Please use the prettier config when making frontend changes
## Local development
Prerequisites:
* Maven
* JDK17
* Node
* npm
There are two ways to run the frontend locally.
1. running `npm run dev` inside the db-scheduler-ui-frontend folder
2. running `mvn install` will build the frontend and copy the output to the resources folder in the `db-scheduler-ui`
module. The frontend will then be available at the same port as the example app.
To run the backend run `mvn clean install` and then run the example app.