Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/polypheny/polypheny-control
A tool for deploying and managing Polypheny-DB.
https://github.com/polypheny/polypheny-control
Last synced: 6 days ago
JSON representation
A tool for deploying and managing Polypheny-DB.
- Host: GitHub
- URL: https://github.com/polypheny/polypheny-control
- Owner: polypheny
- License: apache-2.0
- Created: 2019-09-21T11:44:15.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-07-17T13:37:29.000Z (4 months ago)
- Last Synced: 2024-07-17T16:39:41.504Z (4 months ago)
- Language: Java
- Homepage:
- Size: 690 KB
- Stars: 11
- Watchers: 5
- Forks: 10
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Polypheny Control
Polypheny Control allows to easily setup and monitor Polypheny-DB. It takes care of pulling the required repositories and executing the builds.
Polypheny Control has been designed as a tool for automating the evaluation and benchmarking of Polypheny-DB. Its integrated REST interface allows to easily integrate it into complex benchmarking scenarios.
## Getting Started
This section describes how to set up Polypheny Control to build and run Polypheny-DB.
### Requirements
To build and start Polypheny-DB using Polypheny Control you need to have a Java JDK of version 21 or higher installed on your system.
Thanks to [JGit](https://eclipse.dev/jgit/), Polypheny Control contains a pure Java implementation of Git. Therefore, it is no longer required to have Git installed on the system.
### Setup
Download the latest [polypheny-control.jar](https://github.com/polypheny/Polypheny-Control/releases/latest) from the release section.
On systems with a desktop environment, Polypheny Control can be started by double-clicking the JAR file. Polypheny Control then adds itself to the system tray.
Alternatively, you can also execute the JAR file with the argument `tray`:
```
java -jar polypheny-control.jar tray
```
#### Headless
Polypheny Control can be started in headless mode by specifying the parameter `control`:
```
java -jar polypheny-control.jar control
```
The browser-based user interface can now be accessed on port 8070. This port can be changed using the parameter `-p`:
```
java -jar polypheny-control.jar control -p 8070
```
We strongly recommend not to use any port between 8080 and 8089 as these are the default ports of services offered by Polypheny-DB.
### First Steps
After starting Polypheny Control, open the dashboard in your browser of choice by navigating to `localhost:8070`. If Polypheny Control is running in tray mode, the dashboard can also be opened by clicking on the icon in the system tray and selecting `dashboard`.
In order to start Polypheny-DB, we first need to trigger a build. This can be done by clicking on the :arrows_counterclockwise: button. When the build has completed, run Polypheny-DB by clicking on :arrow_forward:.
You can now open the Polypheny-UI by clicking on the corresponding button on the dashboard.
### Authentication
Polypheny Control features a robust authentication system that ensures access to its functionalities—whether via the CLI, API, or user interface—is restricted to authorized users only.
- **Enable Authentication**: The authentication mechanism can be toggled on or off using `pcrtl.auth.enable=(true|false)`. By default, it's set to `true`, meaning authentication is active.
- **Local Authentication**: If you want to mandate authentication for accessing the API and UI from `localhost`, use the `pcrtl.auth.local=true` configuration. By default, it's false, allowing unauthenticated requests from the same host.
- **CLI Authentication**: By setting `pcrtl.auth.cli=true`, you can enforce authentication for CLI operations, such as restarting Polypheny. However, this might be necessary only under specific scenarios or setups. By default, it is set to false, meaning no CLI authentication is required.
#### The 'passwd' File
The **passwd** file is where user credentials reside. Ensuring its security is paramount. First and foremost, set the correct access permissions, so only trusted users or roles can access it. Additionally, to defend against unsanctioned modifications, you can set the file as immutable using `chattr` on Linux/MacOS or `attrib` on Windows. Remember to reverse this setting if you intend to modify the file via Polypheny Control.
#### Admin User
The **admin** user plays a pivotal role in Polypheny Control, serving as the primary account for managing other users. To set up the admin user:
```bash
java -jar polypheny-control.jar adduser
```
When prompted, use "admin" as the username and choose a strong password. This admin password is essential for performing all user management operations.
Here's a step-by-step guide on typical user management tasks:
```bash
# Setting up the admin user (Note: Passwords are hidden during entry)
> java -jar polypheny-control.jar adduser
Username: admin
Password:
Confirm Password:
# Adding a new user
> java -jar polypheny-control.jar adduser
Username: Loki
Password:
Confirm Password:
Enter 'admin' password (Try 1/3):
# Changing a user's password
> java -jar polypheny-control.jar moduser
Username: Loki
Password:
Confirm Password:
Enter 'admin' password (Try 1/3):
# Deleting a user
> java -jar polypheny-control.jar remuser
Username: Loki
Enter 'admin' password (Try 1/3):
```
## Roadmap
See the [open issues](https://github.com/polypheny/Polypheny-DB/labels/A-control) for a list of proposed features (and known issues).
## Contributing
We highly welcome your contributions to _Polypheny Control_. If you would like to contribute, please fork the repository and submit your changes as a pull request. Please consult our [Admin Repository](https://github.com/polypheny/Admin) and our [Website](https://polypheny.org) for guidelines and additional information.
Please note that we have a [code of conduct](https://github.com/polypheny/Admin/blob/master/CODE_OF_CONDUCT.md). Please follow it in all your interactions with the project.
## Credits
_Polypheny Control_ builds upon the great work of several other open source projects:
#### Frontend
* [ansi_up.js](https://github.com/drudru/ansi_up): Converting text with ANSI terminal codes into colorful HTML.
* [Font Awesome](https://fontawesome.com/): A set of web-related icons.
* [jQuery](https://jquery.com/): The library that makes Javascript usable.
* [jquery.serializeJSON](https://github.com/marioizquierdo/jquery.serializeJSON): Serialize an HTML Form to a JavaScript Object.
* [Tooltipster](https://calebjacob.github.io/tooltipster/): jQuery plugin for modern tooltips.
All these libraries are imported using [WebJars](https://www.webjars.org/).
#### Backend
* [Airline](https://rvesse.github.io/airline/): Annotation-driven Java library for building command line interfaces.
* [Apache Commons](http://commons.apache.org/): A bunch of useful Java utility classes.
* [GSON](https://github.com/google/gson): Convert Java Objects into their JSON representation and vice versa.
* [Guava](https://github.com/google/guava): Set of special collection types.
* [Javalin](https://javalin.io/): A simple and lightweight java web framework.
* [Java-WebSocket](http://tootallnate.github.io/Java-WebSocket/): WebSocket server and client implementation for Java.
* [JGit](https://www.eclipse.org/jgit/): Pure Java implementation of the Git version control system.
* [JSON.simple](https://code.google.com/archive/p/json-simple/): A simple Java toolkit for JSON.
* [Log4j](https://logging.apache.org/log4j/2.x/): Fast and flexible logging framework for Java.
* [Project Lombok](https://projectlombok.org/): A library providing compiler annotations for tedious tasks.
* [SLF4J](http://www.slf4j.org/): Provides a logging API by means of a facade pattern.
* [Typesafe Config](https://lightbend.github.io/config/): A configuration library using HOCON files.
* [Unirest](http://kong.github.io/unirest-java/): A lightweight HTTP client library.
* [WinP](http://winp.kohsuke.org/): Windows process management library.
These projects are used "as is" and are integrated as libraries.
## License
The Apache 2.0 License