Skip to content

JelleBuning/sentinel

Repository files navigation

Contributors Forks Stargazers Issues GNU Affero General Public License v3.0 License

sentinel

Remote Monitoring and Management (RMM) Software.
Demo · Explore the docs

Table of Contents
  1. About The Project
  2. Getting Started
  3. Contributing
  4. License

About The Project

Sentinel is a powerful, scalable, and secure Remote Monitoring and Management (RMM) platform designed to help IT professionals and Managed Service Providers (MSPs) efficiently manage, monitor, and secure client devices and networks from a single dashboard.

With Sentinel, you'll gain full visibility and control over endpoints, proactive alerts, and automation tools that simplify maintenance tasks and increase operational efficiency.

Features

  • Comprehensive Monitoring: Real-time performance metrics and system health indicators for servers and workstations.
  • Automated Maintenance: Schedule automated updates, patches, and maintenance tasks.
  • Security Management: Integrated threat detection and response to protect endpoints from vulnerabilities.
  • Customizable Alerts: Stay informed with tailored alerting systems for critical events.
  • Remote Access: Secure, fast, and reliable remote desktop access.
  • Reporting & Analytics: Generate detailed reports on system performance, compliance, and SLA adherence.
  • User Management: Granular role-based access control (RBAC).
  • Integration-Friendly: Connect with third-party tools such as ticketing systems, antivirus software, and more.

Built With

Getting Started

Setting up this solution on your local machine is straightforward and will enable you to fully utilize its capabilities. This guide will walk you through the necessary steps to get everything running smoothly.

Before beginning, ensure that your development environment is properly configured. Having the required software and dependencies installed will prevent common issues and streamline the process.

Prerequisites

Installation

This installation method utilizes Docker Compose for a streamlined setup. Ensure you have Docker and Docker Compose installed on your system.

  1. Create a docker-compose.yml file: Create a new file named docker-compose.yml in a directory of your choice. Copy and paste the following content into it:

    version: '3.4'
    name: sentinel
    services:
      sentinel.api:
        container_name: "sentinel.api"
        image: ghcr.io/jellebuning/sentinel.api
        ports:
          - "7000:8080"
        environment:
          ASPNETCORE_ENVIRONMENT: "Production" # "Development" | "Production" | "Staging"
          ConnectionStrings__Database: "CONNECTIONSTRING_HERE"
    
  2. Run Docker Compose: In the same directory as your docker-compose.yml file, execute the following command:

    docker-compose up -d

    This command will download the necessary images, create the containers, and start them in detached mode.

  3. Access the API: The API will be available at http://localhost:7000.

Important Notes:

  • Replace "CONNECTIONSTRING_HERE" with a your database connectionstring.

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the GNU Affero General Public License v3.0 License. See LICENSE for more information.

(back to top)

About

Remote Monitoring and Management (RMM) Software.

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Sponsor this project

 

Packages

 
 
 

Contributors 3

  •  
  •  
  •