eduardogsilva.routerfleet/README.md

# RouterFleet

Welcome to **RouterFleet** - the next step in centralized router backup and management. This open source project is designed to revolutionize the way we handle backups and configurations for routers and network equipment, focusing primarily on simplifying and securing network management tasks.

## Introduction

**RouterFleet** is developed with the aim of easing the management of a fleet of devices, particularly focusing on Mikrotik devices during its initial launch phase. This project is a testament to countless hours of dedication towards developing a system that not only simplifies but also secures network management tasks across various devices.

## Features

- **Centralized Backup Management:** Easily manage backups for your routers and network equipment from a single interface.
- **Backup diffing:** Compare backups to identify changes and track configuration history.
- **Multiple backup profiles:** Create multiple backup profiles to manage different schedules and retention polices.
- **Mikrotik Device Compatibility:** Initial support for Mikrotik devices with plans to expand based on community feedback.
- **Continuous Updates:** Regular updates to introduce new functionalities, performance enhancements, and bug fixes.
- **Integration with wireguard:** Integration with [wireguard_webadmin](https://github.com/eduardogsilva/wireguard_webadmin) to easily manage WireGuard VPNs.
- **Open Source:** Dive into the code, contribute, and be a part of a growing community.

## Screenshots
### Backup comparison view (diff)
Easily compare backups to identify changes and track configuration history.
![Backup comparison view](screenshots/backup-diff.png)
### Multiple Backup Profiles
Create multiple backup profiles to manage different schedules and retention policies.
![Multiple Backup Profiles](screenshots/backup-profiles.png)
### Router Details
View detailed information about your routers, including the complete backup history.
![Router Details](screenshots/router-details.png)
### User Management
Manage users and their permissions to ensure secure access to RouterFleet.
![User Management](screenshots/user-manager.png)


## Deployment Instructions

These steps will guide you through deploying the RouterFleet project:

### Step 1: Prepare the Environment

Create a dedicated directory for the RouterFleet project and navigate into it. This directory will serve as your working environment for the deployment.

```bash
mkdir routerfleet && cd routerfleet
```

### Step 2: Fetch the Docker Compose File

Download the appropriate `docker-compose.yml` file directly into your working directory to ensure you're using the latest deployment configuration. Choose one of the following based on your deployment scenario:

#### With Postgres (default setup)

This is the recommended setup for production environments. Download the `docker-compose.yml` that includes the Postgres database container:

```bash
wget -O docker-compose.yml https://raw.githubusercontent.com/eduardogsilva/routerfleet/main/docker-compose.yml
```

#### Without Postgres (sqlite or remote database)

If you prefer to use SQLite or a remote database, download the `docker-compose-no-postgres.yml` file:

```bash
wget -O docker-compose.yml https://raw.githubusercontent.com/eduardogsilva/routerfleet/main/docker-compose-no-postgres.yml
```

### Step 3: Create the `.env` File

Generate a `.env` file in the same directory as your `docker-compose.yml` with the necessary environment variables:

```env
# Configure SERVER_ADDRESS to match the address of the server. If you don't have a DNS name, you can use the IP address.
# A missconfigured SERVER_ADDRESS will cause the app to have CSRF errors.
SERVER_ADDRESS=my_server_address
DEBUG_MODE=False
# Choose a timezone from https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
TIMEZONE=America/Sao_Paulo

# Available options are 'sqlite', 'postgres'
DATABASE_ENGINE=postgres
# If you want to use sqlite or postgres outside of docker, you should use docker-compose-no-postgres.yml
# and provide POSTGRES_HOST, POSTGRES_PORT below.
#POSTGRES_HOST=
#POSTGRES_PORT=
POSTGRES_DB=routerfleet
POSTGRES_USER=routerfleet
POSTGRES_PASSWORD=your_database_password
```

Adjust the variables according to your setup.

### Step 4: Run Docker Compose

If you are upgrading from a previous version, you should consider running ```docker compose pull``` to ensure you are using the latest images.

Start the RouterFleet services using Docker Compose:

```bash
docker compose up -d
```

### Step 5: Update SSL Certificates (Optional)

If you prefer to use your own SSL certificates instead of the auto-generated self-signed certificate:

- Access the `certificates` volume.
- Replace `nginx.pem` and `nginx.key` with your certificate files.

### Step 6: Access the Web Interface

Visit `https://yourserver.example.com` in your web browser to access the RouterFleet web interface. Remember, if you're using the self-signed certificate, you'll need to accept the certificate exception in your browser.

Following these steps will set up RouterFleet on your server, ensuring you're utilizing the latest configurations for optimal performance and security.

## Upgrade Instructions for RouterFleet

To maintain security, performance, and access to new features in RouterFleet, it's important to follow these steps when upgrading:


### Step 1: Prepare the Environment
  
   Begin by navigating to your routerfleet directory:
   ```bash
   cd path/to/routerfleet
   ```

### Step 2: Backup Database

   Before starting the upgrade, it's crucial to back up your database. This step ensures you can revert to the previous state if the upgrade encounters problems. For the database, we recommend manually running a `pg_dump` command to create a backup.
```bash
docker exec -e PGPASSWORD=your_password routerfleet-postgres pg_dump -U routerfleet -d routerfleet > /root/routerfleet-$(date +%Y-%m-%d-%H%M%S).sql
```

### Step 3: Shutdown Services

   Prevent data loss by stopping all RouterFleet services gracefully:
   ```bash
   docker compose down
   ```

### Step 4: Update Docker Compose File

   Download the latest `docker-compose.yml` file from the repository to ensure you're using the most recent version:
   ```bash
   wget -O docker-compose.yml https://raw.githubusercontent.com/eduardogsilva/routerfleet/main/docker-compose.yml
   ```
   Alternatively, if you're using SQLite or a remote database, download the `docker-compose-no-postgres.yml` file:
   ```bash
   # (alternative) No postgres container 
   wget -O docker-compose.yml https://raw.githubusercontent.com/eduardogsilva/routerfleet/main/docker-compose-no-postgres.yml
   ```

### Step 5: Update image files

   Pull the latest images to ensure you're using the most recent versions:
   ```bash
   docker compose pull
   ```

### Step 6: Run Docker Compose

   Start the RouterFleet services using Docker Compose:

   ```bash
   docker compose up -d
   ```

### Post-Upgrade Checks

   - **Verify Operation:** After the services start, access the web interface to ensure routerfleet functions as expected. Examine the application logs for potential issues.
   - **Support and Troubleshooting:** For any complications or need for further information, consult the project's [Discussions](https://github.com/eduardogsilva/routerfleet/discussions) page or relevant documentation.

Following these instructions will help ensure a smooth upgrade process for your RouterFleet installation, keeping it secure and efficient.


## Contributing

As an open source project, RouterFleet thrives on community support. Whether you're a developer, a network engineer, or just someone interested in network management, there are many ways you can contribute:

- **Code Contributions:** Submit pull requests with bug fixes, new features, and improvements.
- **Feedback:** Share your experiences, suggest improvements, and help shape the future of RouterFleet.
- **Documentation:** Help improve the documentation to make RouterFleet more accessible to everyone.
- **Testing:** Report bugs, test new features, and help ensure RouterFleet is stable and reliable.


## Support and Community

Join our community to get support, share ideas, and collaborate:

- [GitHub Issues](https://github.com/eduardogsilva/routerfleet/issues) for reporting bugs and feature requests.
- [Discussions](https://github.com/eduardogsilva/routerfleet/discussions) for sharing ideas and getting help from the community.

Your support and involvement are crucial in shaping the future of RouterFleet. Let's make network management easier and more secure together!

## License

RouterFleet is released under the [MIT License](LICENSE). Feel free to explore, modify, and distribute the software as per the license agreement.

---

We look forward to your contributions and are excited to see how RouterFleet evolves with your help and feedback. Let's build a robust community around efficient and secure network management. Thank you for your support!