https://github.com/n7ghtm4r3/brownie
Self-hosted VPS manager
https://github.com/n7ghtm4r3/brownie
android compose-multiplatform desktop hosts ios java kotlin remote-control self-hosted selfhosted spring-boot springboot ssh tecknobit vps vps-management vps-manager wasmjs web web-app
Last synced: 2 months ago
JSON representation
Self-hosted VPS manager
- Host: GitHub
- URL: https://github.com/n7ghtm4r3/brownie
- Owner: N7ghtm4r3
- License: apache-2.0
- Created: 2025-02-24T09:21:54.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-09T14:57:00.000Z (over 1 year ago)
- Last Synced: 2025-03-09T16:00:40.512Z (over 1 year ago)
- Topics: android, compose-multiplatform, desktop, hosts, ios, java, kotlin, remote-control, self-hosted, selfhosted, spring-boot, springboot, ssh, tecknobit, vps, vps-management, vps-manager, wasmjs, web, web-app
- Language: Java
- Homepage:
- Size: 807 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Brownie
**v1.0.3**
This project is based on the **Compose Multiplatform** and **Spring Boot** technologies and is a
self-hosted VPS manager.
**Brownie** allows you to manage the remote hosts or local ones thanks to the flexibility of
the backend instance which can manage both type of hosts with the same instance. For each hosts you
can add the related services and handle their status such start, reboot and stop them and you can
properly setup each service with different settings.
### Service settings available
- Purge `nohup.out` file when service started or restarted
- Auto run the service when the host started or rebooted
This repository contains the backend version of Brownie, so if you want to customize you can fork it
and work on it, if there are any errors, fixes to do or some idea to enhance this project, please
open a ticket or contact us to talk about, thanks and good use!
## Customize the application
To customize and create your own version of this application you need to have
the
core library implemented in your project and published into maven local system
### Clone the core library and publish to maven local
- Clone the repository or download the zip file of the current version available
- Open the folder file in your development environment and publish to maven local with the
**publishMavenPublicationToMavenLocal** gradle task, take a
look here
for a help
### Implement the core library to your application
- #### Gradle (Short)
```gradle
repositories {
...
mavenLocal()
}
dependencies {
implementation 'com.tecknobit.browniecore:browniecore:1.0.3'
}
```
#### Gradle (Kotlin)
```gradle
repositories {
...
mavenLocal()
}
dependencies {
implementation("com.tecknobit.browniecore:browniecore:1.0.3")
}
```
## Architecture
### Clients
- [Android](https://play.google.com/store/apps/details?id=com.tecknobit.brownie)
- [Brownie desktop version](https://github.com/N7ghtm4r3/Brownie-Clients/releases/tag/1.0.4)
- iOS -> source code available, but cannot distribute due
missing [Apple Developer Program license](https://developer.apple.com/programs/)
- [Brownie webapp version](https://github.com/N7ghtm4r3/Brownie-WebApp)
### Backend
- Backend service "out-of-the-box"
### Backend configuration
> [!WARNING]
> Note The service will run using the *HTTP* protocol as default, it is recommended to implement an *SSL* or *TLS*
> certificate to secure communication on your infrastructure.
>
> **Wikis**
>
> To create a self-signed certificate you can
> look here
>
> To implement a certificate in Spring you can
> look here
>
> If you encounter any problems with the creation of the keystore you can
> look
> here to get more information, or
> use the following command to add the **private key** to the keystore:
> ```xml
> openssl pkcs12 -export -in your_certificate_file.crt -inkey your_private_key.key -out your_out_pkcs12_file.p12 -name your_alias_name -CAfile your_certificate_file.crt -caname root
> ```
#### Default configuration
The default properties to launch the backend service as designed are the following:
``` properties
# The properties considered critical could alter the flow of how the backend service was designed, so we do not recommend
# to change them
spring.datasource.url=jdbc:mysql://localhost:3306/brownie?createDatabaseIfNotExist=true
server.port=1896
spring.datasource.username=root
spring.jpa.generate-ddl=true
spring.jpa.hibernate.ddl.auto=update
spring.jpa.properties.hibernate.dialect=org.hibernate.dialect.MySQL8Dialect
spring.mvc.dispatch-options-request=true
spring.messages.basename=lang/messages
```
The **spring.datasource.username** if is not set is used the default password of the MySQL environment
#### Custom configuration
To customize the properties to launch the backend service you must create a file **in the same folder where you placed
the server file (.jar)** and call it `custom.properties` as below:
``` bash
folderOfWhereYouPlacedTheServerFile
├── custom.properties
└── brownie.jar
```
If your custom properties do not contain the properties of the default configuration will be used these default
properties instead,
so if you need to change some default properties you have to overwrite them.
Take a look to the official page of **Spring** for a high
customization
here
### Run the service
To start the **Brownie** service on your own infrastructure you have to follow these steps
#### Requirements
- At least **Java 18 JDK** installed on your machine
- An SQL environment installed, it is recommended to use **MySQL**
- Before run the backend service, **for the first time only**, you need to store in the **profiles** subfolder **(
created automatically by
the server)** the default profile pic as below:
``` bash
folderOfWhereYouPlacedTheServerFile
├── resources
│ └── profiles
│ └── defProfilePic.png
└── brownie.jar
```
This action is required to provide the **defProfilePic** as logo or profile for the users.
You can take a look directly here
to get more information and to get the **defProfilePic** file to store in the **resources** folder
- The SQL service running on "localhost:3306/brownie" by default, or if has been customized, with the custom data to
format correctly the connection URL
#### Launch the service
When you have to start the service you will have different scenarios:
- At the first launch the server will be interrupted and will be thrown the
**SaveData** exception to store the server secret to manage the user accesses to
the server, share it **only to the users that you retains allowed to access to your server**
``` java
Exception in thread "main" com.tecknobit.apimanager.exceptions.SaveData: Note: is not an error, but is an alert!
Please you should safely save The_server_secret_generated to correctly register a new user in the Brownie system
```
- If is not the first launch the service will start directly
- If you need to recreate the server secret you need to launch the service with the **rss** command like this:
``` java
java -jar Brownie.jar rss // this will generate a new server secret overwriting the current server secret
```
- If you need to delete the server secret, just note that when the service will be launched again will be generated a
new
server secret to work correctly, you need to launch the service with the **dss** or **dssi** command like this:
``` java
// dss command
java -jar Brownie.jar dss // this will delete the current server secret
// dssi command
java -jar Brownie.jar dssi // this will delete the current server secret and interrupts the server workflow right next
```
## Autorun after reboot
To automatically run the **Brownie**'s backend instance after the host machine rebooted or started you can create a dedicated `crontab` to perform this action:
### Open the crontab editor
If you have to choose between the editor choose the suggested one
```bash
crontab -e
```
### Create the crontab task
- `jar` file **in** the home directory
```bash
@reboot /usr/bin/java -jar Brownie.jar
#remove the nohup before restart the new instance
@reboot rm -f nohup.out; sleep 2; /usr/bin/java -jar Brownie.jar
```
- `jar` file **external** from home directory
```bash
@reboot cd /path/to/brownie/ ; /usr/bin/java -jar Brownie.jar
#remove the nohup before restart the new instance
@reboot rm -f /path/to/brownie/nohup.out; sleep 2; cd /path/to/brownie/ ; /usr/bin/java -jar Brownie.jar
```
### Reboot as needed
When you have to reboot the host machine the **Brownie**'s backend instance will be automatically started by the task
created
## Support
If you need help using the library or encounter any problems or bugs, please contact us via the following links:
- Support via email
- Support via GitHub
Thank you for your help!
## Badges
[](https://play.google.com/store/apps/developer?id=Tecknobit)
[](https://twitter.com/tecknobit)
[](https://www.oracle.com/java/)
[](https://kotlinlang.org/)
[](https://spring.io/projects/spring-boot)
## Donations
If you want support project and developer
| Crypto | Address | Network |
|-----------------------------------------------------------------------------------------------------|--------------------------------------------------|----------|
|  | **3H3jyCzcRmnxroHthuXh22GXXSmizin2yp** | Bitcoin |
|  | **0x1b45bc41efeb3ed655b078f95086f25fc83345c4** | Ethereum |
|  | **AtPjUnxYFHw3a6Si9HinQtyPTqsdbfdKX3dJ1xiDjbrL** | Solana |
If you want support project and developer
with [PayPal](https://www.paypal.com/donate/?hosted_button_id=5QMN5UQH7LDT4)
Copyright © 2025 Tecknobit