https://github.com/r0mb0/pivpn_gui
I just wanna try to create a GUI for PIVPN in way to make easy interact with the service and increase some features
https://github.com/r0mb0/pivpn_gui
desktop-app desktop-application flutter flutter-app itai-developers linux pivpn r0mb0 university-project urbino-university vpn vpn-manager
Last synced: about 2 months ago
JSON representation
I just wanna try to create a GUI for PIVPN in way to make easy interact with the service and increase some features
- Host: GitHub
- URL: https://github.com/r0mb0/pivpn_gui
- Owner: R0mb0
- License: agpl-3.0
- Created: 2024-12-17T13:52:51.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2025-03-11T07:57:17.000Z (3 months ago)
- Last Synced: 2025-04-20T22:46:38.979Z (about 2 months ago)
- Topics: desktop-app, desktop-application, flutter, flutter-app, itai-developers, linux, pivpn, r0mb0, university-project, urbino-university, vpn, vpn-manager
- Language: Dart
- Homepage:
- Size: 555 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
- Support: SUPPORT.md
Awesome Lists containing this project
README
Urbino`s University - Computing and digital innovation - Programming of mobile devices and user interfaces
# PIVPN GUI
[](https://app.codacy.com/gh/R0mb0/PIVPN_GUI/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
[](https://github.com/R0mb0/PIVPN_GUI)
[](https://github.com/R0mb0/PIVPN_GUI)
[](https://www.gnu.org/licenses/gpl-3.0)
[](http://paypal.me/R0mb0)
## Description
**PIVPN GUI** is a flutter application to simplify the manage of [`PIVPN`](https://github.com/pivpn/pivpn) service for most of commons users. It provide the "time to be enabled" functionality, in way to automatic disable clients that had terminated their "enabled time". For example this functionality is usefull if the vpn is used to distribute a subscription service.
> Until the application is open, one time a day, the application will check all user statuses, disabling the users with their "time to be enabled" over.
## How to install
### 1. PIVPN installation
- [how to install PIVPN](https://github.com/pivpn/pivpn)
### 2. Flutter installation
- [How to install flutter](https://flutter-ko.dev/get-started/install)
### 3. Download the application
- ```bash
git clone https://github.com/R0mb0/PIVPN_GUI.git
```
## How to run
1. Enter into the working directory
```bash
cd PIVPN_GUI/PIVPN_GUI/pivpn_gui/lib
```
2. Make executable `make_all_scripts_executable.sh` script
```bash
chmod +x make_all_scripts_executable.sh
```
3. Run the script
```
./make_all_scripts_executable.sh
```
4. Create the `password.sh` file
- Create with your favorite editor `password.sh`
```bash
nano password.sh
```
- Add this code inside the file
```bash
#!/bin/bash
PASSWORD = "your_sudo_password"
```
Save the file
`ctrl + o`
`ctrl + x`
5. Run the application
```bash
flutter run
```
## Interface description
- `Name`, `Start Date`, `End Date` are "Text Fields"
- `Is always allowed?` is a "Check Box" (false as default)
- `ADD USER`, `REMOVE USER`, `ENABLE USER`, `DISABLE USER`, `SAVE DATABASE`, `LOAD DATABASE` are "Buttons"
- In the center, below the "Buttons" there's the section for the application's allerts
- In the center of the page there's a table where check all clients and client statuses
## How to use
> `Name` field is used for all operations except for `SAVE DATABASE` and `LOAD DATABASE`
> `Start Date`, `End Date` `Is always allowed?` Fields are used only for "add new user" operation
### Add a new user
- Complete `Name`, `Start Date` and `End Date` fields, and check if the user `Is always allowed`
- Press `ADD USER` button
### Remove an user
- write the name of the user to remove in `name` field
- Press `REMOVE USER` button
### Enable an user
- write the name of the user to enable in `name` field
- Press `ENABLE USER` button
### Disable an user
- write the name of the user to disable in `name` field
- Press `DISABLE USER` button