Comprehensive audit log showing all system activities and user actions
12 |
13 |
14 | ## Provider Audit Logs
15 |
16 | Track all actions performed on providers:
17 |
18 | - **Provider Creation**: When new providers are added
19 | - **Configuration Changes**: Modifications to provider settings
20 | - **Provider Removal**: When providers are deleted
21 |
22 | ## Log Information
23 |
24 | Each audit entry includes:
25 |
26 | - **Timestamp**: When the action occurred
27 | - **User**: Who performed the action
28 | - **Action Type**: What was done
29 | - **Provider**: Which provider was affected
30 |
--------------------------------------------------------------------------------
/opsimate-docs/docs/providers-services/services/container-services.md:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 3
3 | ---
4 |
5 | # Docker Containers
6 |
7 | Monitor Docker containers running on your servers.
8 |
9 | ## Adding
10 |
11 | **Automatic Detection**: OpsiMate checks for existing containers, and you can add them directly from the add screen.
12 |
13 | ### Process
14 | 1. Click the three-dots menu
15 | 2. Select "Add Services"
16 | 3. Choose your server provider
17 | 4. Select "Docker Container" type
18 | 5. Choose from detected containers
19 |
20 |
21 |
22 |
Adding a Docker container service to OpsiMate
23 |
24 |
25 | ## Control
26 |
27 | **Docker Commands**: Controlled via SSH commands with Docker.
28 |
29 | ### Basic Operations
30 | ```bash
31 | # Start container
32 | docker start container-name
33 |
34 | # Stop container
35 | docker stop container-name
36 |
37 | # Restart container
38 | docker restart container-name
39 |
40 | ```
41 |
--------------------------------------------------------------------------------
/opsimate-docs/docs/providers-services/services/systemd-services.md:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 2
3 | ---
4 |
5 | # Systemd Services
6 |
7 | Monitor Linux system services managed by systemd.
8 |
9 | ## Adding
10 |
11 | **Manual Entry**: Added manually by entering the service name.
12 |
13 | ### Process
14 | 1. Click the three-dots menu
15 | 2. Select "Add Services"
16 | 3. Choose your server provider
17 | 4. Select "Systemd Service" type
18 | 5. Enter the service name (e.g., "nginx", "postgresql")
19 |
20 |
21 |
22 |
Adding a systemd service to OpsiMate
23 |
24 |
25 | ## Control
26 |
27 | **SSH Commands**: Controlled via SSH commands using `service start`, `stop`, `restart`, to manage the service.
28 |
29 | ### Basic Operations
30 | ```bash
31 | # Start service
32 | sudo systemctl start service-name
33 |
34 | # Stop service
35 | sudo systemctl stop service-name
36 |
37 | # Restart service
38 | sudo systemctl restart service-name
39 | ```
--------------------------------------------------------------------------------
/opsimate-docs/docs/integrations/grafana.md:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 2
3 | tags: [Links, Monitoring Data, Alerts]
4 | ---
5 |
6 | # Grafana Integration
7 |
8 | **Grafana** is an open-source analytics and interactive visualization platform. It provides charts, graphs, and alerts for monitoring data from various sources.
9 |
10 | **Integration Capabilities:**
11 | - 🔗 **Links**: Direct access to Grafana dashboards from services
12 | - 🚨 **Alerts**: Receive Grafana alerts in OpsiMate
13 |
14 | ## Configuration Parameters
15 |
16 | Required credentials to connect to Grafana:
17 |
18 | - **Grafana URL**: Your Grafana instance URL (e.g., `https://grafana.company.com`)
19 | - **API Key**: Generated from Grafana with Admin or Editor role
20 |
21 | ## Functionality
22 |
23 | ### Dashboard Links
24 | - Access Grafana dashboards directly from OpsiMate services
25 | - Automatic linking based on service names and tags
26 | - Open dashboards in new tabs or embedded views
27 |
28 | ### Alert Integration
29 | - Receive Grafana alerts in OpsiMate notification system
30 | - Correlate alerts with service status and events
31 | - Unified alert management across monitoring tools
32 |
33 | ## Official Resources
34 |
35 | - **Grafana Website**: [https://grafana.com](https://grafana.com)
36 | - **Documentation**: [https://grafana.com/docs](https://grafana.com/docs)
37 |
--------------------------------------------------------------------------------
/opsimate-docs/docs/legal/privacy.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Privacy Policy & Cookie Policy
3 | description: OpsiMate Privacy Policy and Cookie Usage
4 | sidebar_position: 1
5 | ---
6 |
7 | # Privacy Policy & Cookie Policy
8 |
9 | Last updated: January 2025
10 |
11 | ## Cookie Usage
12 |
13 | OpsiMate uses cookies and similar technologies to provide, secure, and improve our services.
14 |
15 | ### Essential Cookies
16 | These cookies are necessary for the website to function and cannot be switched off.
17 |
18 | ### Analytics Cookies
19 | These cookies help us understand how visitors interact with our documentation.
20 |
21 | ### Marketing Cookies
22 | These cookies are used to track visitors across websites to display relevant advertisements.
23 |
24 | ## Your Choices
25 |
26 | You can manage your cookie preferences at any time by clearing your browser cookies or using the cookie consent banner.
27 |
28 | ---
29 |
30 | ## Privacy Policy
31 |
32 | ### Information We Collect
33 | - Usage data and analytics
34 | - Cookie preferences
35 | - Documentation access patterns
36 |
37 | ### How We Use Your Information
38 | - Improve our documentation
39 | - Understand user needs
40 | - Provide better support
41 |
42 | ### Data Protection
43 | We are committed to protecting your privacy and securing your data.
44 |
45 | ### Contact Us
46 | For privacy-related questions, contact our team.
--------------------------------------------------------------------------------
/opsimate-docs/docs/providers-services/services/add-services.md:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 1
3 | ---
4 |
5 | # Add Services
6 |
7 | Add and configure services for monitoring across your providers.
8 |
9 | ## Basic Flow
10 |
11 | Adding services is done using the **Add Services** button in the menu that opens when clicking the three-dots icon.
12 |
13 | 1. **Go to “My Provider” Page**
14 | Open the **My Provider** page in your OpsiMate dashboard.
15 |
16 | 2. **Access the Menu**
17 | Click the **three‑dots** menu icon for the chosen provider.
18 |
19 | 3. **Add Services**
20 | Select **Add Services** from the menu options.
21 |
22 | 4. **Select Services**
23 | Choose the services you want to connect and manage.
24 |
25 | 5. **Start Managing**
26 | Confirm your selection. OpsiMate will now let you monitor and control these services.
27 |
28 | Based on the provider, you can select the services that are relevant to that specific provider.
29 |
30 |
31 |
32 | ## Next Steps
33 |
34 | After adding your services:
35 |
36 | 1. **[Monitor Services](../../dashboards/overview)** - View service status and metrics
37 | 2. **[Set Up Alerts](../../alerts/adding-alerts)** - Get notified of issues
38 |
39 | :::tip Pro Tip
40 | Start with basic health checks and gradually add more sophisticated monitoring as you learn what works best for your services.
41 | :::
42 |
--------------------------------------------------------------------------------
/opsimate-docs/docs/providers-services/providers/kubernetes-provider.md:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 3
3 | ---
4 |
5 | # Kubernetes Provider
6 |
7 | Monitor Kubernetes clusters through kubeconfig-based API connectivity.
8 |
9 | ## Configuration
10 |
11 | Kubernetes providers require kubeconfig file access to establish cluster monitoring capabilities.
12 |
13 | ### Connection Parameters
14 |
15 | | Parameter | Type | Description | Required |
16 | |-----------|------|-------------|----------|
17 | | **Kubeconfig File** | String | Kubeconfig filename for cluster access | Yes |
18 |
19 | ### Kubeconfig Configuration
20 |
21 | Place your kubeconfig files in the `data/private-keys/` directory and reference only the filename:
22 |
23 |
24 |
25 |
Kubernetes provider configuration form
26 |
27 |
28 | ## Types of Services
29 |
30 | Kubernetes providers support automatic pod discovery.
31 |
32 | ### Pods
33 |
34 | **Automatic Discovery**: OpsiMate automatically detects all pods within the configured cluster context and you can add them as a services directly from the my providers page.
--------------------------------------------------------------------------------
/opsimate-docs/docs/alerts/alert-management.md:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 2
3 | ---
4 |
5 | # Alert Management
6 |
7 | The Alert Management page provides a centralized view of all alerts across your services and integrations.
8 |
9 |
10 |
11 |
12 |
OpsiMate alerts dashboard showing real-time notifications and alert management
13 |
14 |
15 | ## Overview
16 |
17 | Access the Alert Management page to:
18 |
19 | - **View all alerts**: See alerts from all integration sources in one place
20 | - **Filter and search**: Find specific alerts by service, severity, or status
21 |
22 | ## Alert Dashboard Features
23 |
24 | ### All Active Alerts
25 | View currently active alerts across all your services:
26 | - Real-time status updates from integration providers
27 | - Severity levels (Critical, Warning, Info)
28 | - Associated services and tags
29 | - Time since alert started
30 |
31 | ## Integration Sources
32 |
33 | Alerts are aggregated from all configured integrations:
34 | - Grafana alert rules
35 |
36 | Each alert shows its source integration for easy traceability back to the original monitoring system.
37 |
--------------------------------------------------------------------------------
/opsimate-docs/docs/integrations/datadog.md:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 5
3 | tags: [Links, Monitoring Data]
4 | ---
5 |
6 | # DataDog Integration
7 |
8 | **DataDog** is a monitoring and analytics platform for cloud-scale applications, providing monitoring of servers, databases, tools, and services through a SaaS-based data analytics platform.
9 |
10 | **Integration Capabilities:**
11 | - 🔗 **Links**: Direct access to DataDog dashboards and metrics from services
12 |
13 | ## Configuration Parameters
14 |
15 | Required credentials to connect to DataDog:
16 |
17 | - **DataDog Site**: Your DataDog site (e.g., `us5.datadoghq.com` for US, `datadoghq.eu` for EU)
18 | - **API Key**: Your DataDog API key for authentication
19 | - **Application Key**: (Optional) Required for certain API operations
20 |
21 | ## Functionality
22 |
23 | ### Dashboard Links
24 | - Access DataDog dashboards directly from OpsiMate services
25 | - View service-specific metrics and logs in DataDog
26 | - Quick navigation to related dashboards and monitors
27 |
28 | ## Official Resources
29 |
30 | - **DataDog Website**: [https://www.datadoghq.com/](https://www.datadoghq.com/)
31 | - **Documentation**: [https://docs.datadoghq.com/](https://docs.datadoghq.com/)
32 | - **API Documentation**: [https://docs.datadoghq.com/api/](https://docs.datadoghq.com/)
33 | - **Getting Started**: [https://docs.datadoghq.com/getting_started/](https://docs.datadoghq.com/getting_started/)
34 |
--------------------------------------------------------------------------------
/opsimate-docs/static/img/vercel.svg:
--------------------------------------------------------------------------------
1 |
4 |
--------------------------------------------------------------------------------
/opsimate-docs/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "opsimate-docs",
3 | "version": "0.0.0",
4 | "private": true,
5 | "scripts": {
6 | "docusaurus": "docusaurus",
7 | "start": "docusaurus start",
8 | "build": "docusaurus build",
9 | "swizzle": "docusaurus swizzle",
10 | "deploy": "docusaurus deploy",
11 | "clear": "docusaurus clear",
12 | "serve": "docusaurus serve",
13 | "write-translations": "docusaurus write-translations",
14 | "write-heading-ids": "docusaurus write-heading-ids",
15 | "typecheck": "tsc"
16 | },
17 | "dependencies": {
18 | "@docsearch/css": "^4.1.0",
19 | "@docsearch/js": "^4.1.0",
20 | "@docusaurus/core": "3.8.1",
21 | "@docusaurus/preset-classic": "3.8.1",
22 | "@mdx-js/react": "^3.0.0",
23 | "@vercel/analytics": "^1.3.1",
24 | "clsx": "^2.0.0",
25 | "prism-react-renderer": "^2.3.0",
26 | "react": "^19.0.0",
27 | "react-dom": "^19.0.0"
28 | },
29 | "devDependencies": {
30 | "@docusaurus/module-type-aliases": "3.8.1",
31 | "@docusaurus/tsconfig": "3.8.1",
32 | "@docusaurus/types": "3.8.1",
33 | "typescript": "~5.6.2"
34 | },
35 | "browserslist": {
36 | "production": [
37 | ">0.5%",
38 | "not dead",
39 | "not op_mini all"
40 | ],
41 | "development": [
42 | "last 3 chrome version",
43 | "last 3 firefox version",
44 | "last 5 safari version"
45 | ]
46 | },
47 | "engines": {
48 | "node": ">=18.0"
49 | }
50 | }
51 |
--------------------------------------------------------------------------------
/opsimate-docs/docs/providers-services/providers/server-provider.md:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 2
3 | ---
4 |
5 | # Server Provider
6 |
7 | Monitor services running on individual servers with SSH access.
8 |
9 | ## What is a Server Provider?
10 |
11 | A Server Provider represents a single server that hosts multiple services. This is the most common provider type for traditional infrastructure.
12 |
13 | ## Quick Setup
14 |
15 | ### Prerequisites
16 | - SSH access to the target server
17 | - SSH key authentication (recommended) or password access
18 | - Server running Linux, macOS, or Windows with SSH server
19 |
20 | ### Basic Configuration
21 |
22 | ```yaml
23 | name: "Production Web Server"
24 | type: "server"
25 | host: "192.168.1.100"
26 | port: 22
27 |
28 | ```yaml
29 | ssh_key_file: "server_key.pem"
30 | ```
31 |
32 |
33 |
34 |
Adding a server provider to OpsiMate
35 |
36 |
37 | ## Types of Services
38 |
39 | Server providers support two primary service monitoring approaches:
40 |
41 | ### Docker Containers
42 |
43 | **Automatic Discovery**: OpsiMate automatically detects all Docker containers running on the server, and you can add them directly from the my providers page.
44 |
45 | ### Systemd Services
46 |
47 | **Manual Configuration**: Systemd services require manual specification during the service addition process.
48 |
--------------------------------------------------------------------------------
/opsimate-docs/docs/getting-started/configuration.md:
--------------------------------------------------------------------------------
1 | ---
2 | id: configuration
3 | title: Configuration
4 | sidebar_position: 3
5 | ---
6 |
7 | # Configuration
8 |
9 | OpsiMate uses a YAML configuration file to manage application settings. This guide covers all available configuration options.
10 |
11 | ## Basic Configuration
12 |
13 | ### Minimal Configuration
14 |
15 | ```yaml title="configfile.yml"
16 | # OpsiMate Configuration
17 | # Simple configuration file with essential settings
18 |
19 | # Server configuration
20 | server:
21 | port: 3001 # Backend API server port
22 | host: "localhost" # Use "0.0.0.0" for Docker
23 |
24 | # Client configuration
25 | client:
26 | port: 8080 # Frontend development server port
27 | api_url: "http://localhost:3001/api/v1" # Backend API URL
28 |
29 | # Database configuration
30 | database:
31 | path: "/app/data/database/opsimate.db" # SQLite database file path (mounted volume)
32 |
33 | # Security configuration
34 | security:
35 | private_keys_path: "/app/data/private-keys" # SSH private keys directory (mounted volume)
36 |
37 | ```
38 |
39 | ## Next Steps
40 |
41 | After configuring OpsiMate:
42 |
43 | 1. **Restart the container** to apply changes
44 | 2. **Add providers** - [Learn how](../providers-services/providers/add-provider)
45 | 3. **Set up monitoring** - [Configure alerts](../alerts/adding-alerts.md)
46 | 4. **Start discovering services** - [Quick start guide](../providers-services/services/add-services)
47 |
48 | ## Support
49 |
50 | If you need help with configuration:
51 |
52 | - Check the [deployment guide](deploy) for basic setup
53 | - Join our [community discussions](https://github.com/opsimate/opsimate/discussions)
54 | - Report configuration issues on [GitHub](https://github.com/opsimate/opsimate/issues)
55 |
--------------------------------------------------------------------------------
/opsimate-docs/docs/alerts/adding-alerts.md:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 1
3 | ---
4 |
5 | # Adding Alerts
6 |
7 | Learn how to set up alerts for your services through integration providers like Grafana.
8 |
9 | ## How It Works
10 |
11 | Alerts in OpsiMate are created through integrations with external alert providers. When you configure an integration like Grafana, alerts from that system are automatically pulled into OpsiMate and associated with your services.
12 |
13 | ## Setting Up Alerts
14 |
15 | ### 1. Tag Your Services
16 | First, ensure your services have proper tags that match your alert configuration:
17 |
18 | - Navigate to your service in the dashboard
19 | - Add relevant tags that correspond to your alert rules
20 | - Common tags include: `environment`, `team`, `criticality`, `component`
21 |
22 | ### 2. Configure Integration
23 | Set up your alert provider integration:
24 |
25 | - Go to **Integrations** → **External Integrations**
26 | - Configure your alert provider (e.g., Grafana)
27 | - Ensure the integration has access to your alert rules
28 | - Map alert tags to service tags for proper association
29 |
30 | ### 3. Alert Association
31 | OpsiMate automatically associates alerts with services based on:
32 |
33 | **Tag matching**: Alerts with tags that match service tags
34 |
35 | ## Viewing Alerts
36 |
37 | Once configured, you can view alerts directly in the **Service Menu** within the dashboard:
38 |
39 | - Navigate to any service in your dashboard
40 | - Click on the service to open the Service Menu
41 | - Alerts will appear in the alerts section
42 | - View alert status, severity, and details
43 |
44 | ## Alert States
45 |
46 | Alerts can have the following states:
47 | - **Active**: Currently firing
48 | - **Dismissed**: Manually acknowledged by a user
49 |
50 | The system automatically updates alert states based on your integration provider's data.
51 |
--------------------------------------------------------------------------------
/opsimate-docs/docs/providers-services/providers/add-provider.md:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 1
3 | ---
4 |
5 | # Adding Providers
6 |
7 | Connect your infrastructure to OpsiMate.
8 |
9 | ## Quick Setup
10 |
11 | ### Add Provider
12 |
13 | Adding a provider to OpsiMate is simple and takes just a few steps:
14 |
15 | 1. **Open the Providers Section**
16 | From your OpsiMate dashboard, navigate to **Providers**.
17 |
18 | 2. **Select a Provider Type**
19 | Choose from the available types such as Server, Kubernetes or other supported providers.
20 |
21 | 3. **Configure and Test**
22 | Enter the required connection details and run a quick test to confirm connectivity.
23 |
24 | 4. **Enable Monitoring**
25 | Save your configuration and start adding services.
26 |
27 |
28 |
29 |
My Providers page showing configured infrastructure providers and their services
30 |
31 |
32 | ## Next Steps
33 |
34 | Once your provider is added:
35 |
36 | 1. **[Configure Services](../services/add-services)** - Fine-tune service monitoring
37 | 2. **[Set Up Alerts](../../alerts/adding-alerts)** - Get notified of issues
38 |
39 | :::info Provider Types
40 | You can find detailed guides for specific provider types in the other pages in this folder:
41 |
42 | - **[Server Provider](server-provider)** - SSH-based server monitoring
43 | - **[Kubernetes Provider](kubernetes-provider)** - K8s cluster integration
44 | :::
45 |
46 | :::tip Best Practice
47 | Start with one provider and ensure it's working perfectly before adding more. This makes troubleshooting much easier!
48 | :::
49 |
--------------------------------------------------------------------------------
/opsimate-docs/docs/integrations/overview.md:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 1
3 | ---
4 |
5 | # Integrations Overview
6 |
7 | Integrations are the way to connect external tools to OpsiMate. The goal is to leverage existing tools to enable monitoring, control, and interaction with other interfaces.
8 |
9 | ## Integration Layers
10 |
11 |
12 |
13 | 🚨 Receiving Alerts
14 |
Get alerts from external monitoring systems
15 |
16 |
17 | 🔗 External Links
18 |
Link external URLs and dashboards to services
19 |
20 |
21 | 📊 Monitoring Data
22 |
Add logs, metrics, and performance data
23 |
24 |
25 | ⚡ Actions
26 |
Use tools to control services and run actions
27 |
28 |
29 |
30 | ## Available Integrations
31 |
32 | ### Grafana
33 |
34 | Visualization and dashboarding platform for metrics and monitoring data.
35 |
36 | ### Kibana
37 |
38 | Data visualization dashboard for Elasticsearch, used for log analysis and search.
39 |
40 | ### DataDog
41 |
42 | Cloud monitoring and analytics platform for infrastructure, applications, and logs.
43 |
44 | ## Getting Started
45 |
46 | 1. Navigate to **My Integrations** page
47 | 2. Click **External Integrations** tab
48 | 3. Choose your integration type
49 | 4. Follow the setup instructions
50 |
51 |
52 |
53 |
Setting up Grafana integration in OpsiMate
54 |
55 |
56 | Select an integration to learn how to set it up:
57 |
58 | - [Setting up Grafana Integration](/docs/integrations/grafana)
59 | - [Setting up Kibana Integration](/docs/integrations/kibana)
60 |
--------------------------------------------------------------------------------
/opsimate-docs/README.md:
--------------------------------------------------------------------------------
1 | # OpsiMate Documentation
2 |
3 | This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
4 |
5 | ## Installation
6 |
7 | ```bash
8 | npm install
9 | ```
10 |
11 | ## Local Development
12 |
13 | ```bash
14 | npm run start
15 | ```
16 |
17 | This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
18 |
19 | ## Build
20 |
21 | ```bash
22 | npm run build
23 | ```
24 |
25 | This command generates static content into the `build` directory and can be served using any static contents hosting service.
26 |
27 | ## Deployment to Vercel
28 |
29 | This documentation site is configured for seamless deployment on Vercel. Follow these steps to deploy:
30 |
31 | 1. **Push your code to GitHub**
32 | ```bash
33 | git add .
34 | git commit -m "Documentation ready for deployment"
35 | git push
36 | ```
37 |
38 | 2. **Import to Vercel**
39 | - Go to [Vercel](https://vercel.com/new)
40 | - Import your GitHub repository
41 | - Select the repository containing this documentation
42 |
43 | 3. **Configure the project**
44 | - Framework Preset: Select "Docusaurus"
45 | - Build Command: `npm run build`
46 | - Output Directory: `build`
47 | - Install Command: `npm install`
48 |
49 | 4. **Environment Variables**
50 | No additional environment variables are required for basic deployment.
51 |
52 | 5. **Deploy**
53 | Click "Deploy" and Vercel will build and deploy your documentation site.
54 |
55 | ## Features
56 |
57 | - **Multi-page Documentation**: Organized into logical sections
58 | - **Responsive Design**: Works on mobile and desktop
59 | - **Search**: Built-in search functionality
60 | - **Versioning**: Support for multiple versions of documentation
61 | - **Community Links**: Integration with Slack and GitHub
62 |
63 | ## Community
64 |
65 | - [GitHub Repository](https://github.com/Fifaboyz/OpsiMate)
66 | - [Slack Community](https://join.slack.com/t/opsimate/shared_invite/zt-39bq3x6et-NrVCZzH7xuBGIXmOjJM7gA)
67 |
--------------------------------------------------------------------------------
/opsimate-docs/docs/core-features.md:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 2
3 | ---
4 |
5 | # 🚀 Core Features
6 |
7 | OpsiMate brings everything together in one powerful platform - your complete infrastructure command center.
8 |
9 | ## 🌐 All in the Same Place
10 |
11 | **Every Infrastructure, Everywhere**
12 | - From bare metal servers to Kubernetes clusters
13 | - AWS Lambda functions and cloud services
14 | - Docker containers and virtual machines
15 | - All your monitoring tools and 3rd party integrations
16 | - One unified view of your entire technology stack
17 |
18 | ## 💍 One Ring to Rule Them All
19 |
20 | **Control Everything from One Place**
21 | - Want to run a script on a server? ✅
22 | - Need to restart a Docker container? ✅
23 | - Trigger a Jenkins pipeline? ✅
24 | - Scale your Kubernetes deployment? ✅
25 | - Execute any action across your entire infrastructure and toolchain
26 |
27 | ## 👥 Simple for Everyone
28 |
29 | **User Interface Made for All**
30 | - **Project Owners & Customers**: Clear status dashboards to understand system health
31 | - **DevOps Engineers**: Powerful controls to manage and fix issues quickly
32 | - **Software Engineers**: Easy access to logs, metrics, and troubleshooting tools
33 | - **Non-Technical Users**: Simple, intuitive interface that anyone can understand
34 |
35 | ## 📊 Unified Monitoring View
36 |
37 | **Connect All Your Tools**
38 | - Integrate monitoring tools, alerts, metrics, and logs
39 | - See exactly what impacts your environment
40 | - Correlate data from multiple sources
41 | - Get the complete picture in one consolidated view
42 |
43 | ---
44 |
45 | ## 🎯 Getting Started
46 |
47 | Ready to explore OpsiMate's capabilities? Start with:
48 |
49 | 1. **[Deploy OpsiMate](getting-started/deploy)** - Set up your monitoring platform
50 | 2. **[Add Providers](providers-services/providers/add-provider)** - Connect your infrastructure
51 | 3. **[Configure Services](providers-services/services/add-services)** - Set up service monitoring
52 | 4. **[Create Alerts](alerts/adding-alerts)** - Get notified of issues
53 |
54 | :::tip
55 | OpsiMate automatically discovers services when you add providers, making setup fast and comprehensive.
56 | :::
57 |
--------------------------------------------------------------------------------
/opsimate-docs/docs/intro.md:
--------------------------------------------------------------------------------
1 | ---
2 | id: intro
3 | slug: /
4 | sidebar_position: 1
5 | ---
6 |
7 | # Welcome to OpsiMate
8 |
9 |
10 |
11 |
Simplify Your Infrastructure Management
12 |
One platform to monitor, manage, and optimize your entire infrastructure
13 |
14 |
15 |
16 | ## 🚀 The OpsiMate Vision
17 |
18 | In today's complex infrastructure landscape, teams struggle with fragmented monitoring tools, scattered dashboards, and reactive incident management. **OpsiMate was born from a simple yet powerful idea**: *What if you could manage your entire infrastructure from a single, intuitive platform?*
19 |
20 | :::tip 💡 Our Mission
21 | To transform how teams monitor and manage their infrastructure by providing a unified, intelligent platform that turns complexity into clarity.
22 | :::
23 |
24 | ## 🎯 Why OpsiMate Exists
25 |
26 | **The Problem We Solve:**
27 | - 🔍 **Fragmented Visibility** - Multiple tools, multiple dashboards, no single source of truth
28 | - ⚡ **Reactive Operations** - Discovering issues after they impact users
29 | - 🔄 **Manual Processes** - Time-consuming manual tasks that could be automated
30 | - 📊 **Data Silos** - Metrics, logs, and alerts scattered across different systems
31 |
32 | **Our Solution:**
33 | OpsiMate unifies your entire infrastructure ecosystem into one intelligent platform that not only monitors but actively helps you manage and optimize your services.
34 |
35 | ## 🌱 Getting Started
36 |
37 | Ready to transform your infrastructure management? OpsiMate is designed to get you up and running quickly:
38 |
39 | 1. **📝 [Installation Guide](./getting-started/deploy)** - Set up OpsiMate in minutes
40 | 2. **📚 [Explore Features](./core-features)** - Discover what OpsiMate can do for your team
41 |
42 | :::info 👥 Join Our Community
43 | Have questions? Join our [Slack Community](https://join.slack.com/t/opsimate/shared_invite/zt-39bq3x6et-NrVCZzH7xuBGIXmOjJM7gA) or check out our [GitHub](https://github.com/Fifaboyz/OpsiMate) repository.
44 | :::
45 |
46 | ---
47 |
48 | *Ready to simplify your infrastructure management? Let's get started! 🚀*
49 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | # Dependencies
2 | *node_modules*
3 | node_modules/
4 | */node_modules/
5 |
6 | # Logs
7 | npm-debug.log*
8 | yarn-debug.log*
9 | yarn-error.log*
10 | lerna-debug.log*
11 |
12 | # Runtime data
13 | pids
14 | *.pid
15 | *.seed
16 | *.pid.lock
17 |
18 | # Coverage directory used by tools like istanbul
19 | coverage/
20 | *.lcov
21 |
22 | # nyc test coverage
23 | .nyc_output
24 |
25 | # Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
26 | .grunt
27 |
28 | # Bower dependency directory (https://bower.io/)
29 | bower_components
30 |
31 | # node-waf configuration
32 | .lock-wscript
33 |
34 | # Compiled binary addons (https://nodejs.org/api/addons.html)
35 | build/Release
36 |
37 | # Dependency directories
38 | jspm_packages/
39 |
40 | # TypeScript v1 declaration files
41 | typings/
42 |
43 | # TypeScript cache
44 | *.tsbuildinfo
45 |
46 | # Optional npm cache directory
47 | .npm
48 |
49 | # Optional eslint cache
50 | .eslintcache
51 |
52 | # Microbundle cache
53 | .rpt2_cache/
54 | .rts2_cache_cjs/
55 | .rts2_cache_es/
56 | .rts2_cache_umd/
57 |
58 | # Optional REPL history
59 | .node_repl_history
60 |
61 | # Output of 'npm pack'
62 | *.tgz
63 |
64 | # Yarn Integrity file
65 | .yarn-integrity
66 |
67 | # dotenv environment variables file
68 | .env
69 | .env.test
70 | .env.local
71 | .env.development.local
72 | .env.test.local
73 | .env.production.local
74 |
75 | # parcel-bundler cache (https://parceljs.org/)
76 | .cache
77 | .parcel-cache
78 |
79 | # Next.js build output
80 | .next
81 |
82 | # Nuxt.js build / generate output
83 | .nuxt
84 | dist
85 |
86 | # Gatsby files
87 | .cache/
88 | public
89 |
90 | # Storybook build outputs
91 | .out
92 | .storybook-out
93 |
94 | # Temporary folders
95 | tmp/
96 | temp/
97 |
98 | # Logs
99 | logs
100 | *.log
101 |
102 | # Runtime data
103 | pids
104 | *.pid
105 | *.seed
106 | *.pid.lock
107 |
108 | # Optional npm cache directory
109 | .npm
110 |
111 | # Optional REPL history
112 | .node_repl_history
113 |
114 | # Output of 'npm pack'
115 | *.tgz
116 |
117 | # Yarn Integrity file
118 | .yarn-integrity
119 |
120 | # dotenv environment variables file
121 | .env
122 |
123 | # IDE files
124 | .vscode/
125 | .idea/
126 | *.swp
127 | *.swo
128 | *~
129 |
130 | # OS generated files
131 | .DS_Store
132 | .DS_Store?
133 | ._*
134 | .Spotlight-V100
135 | .Trashes
136 | ehthumbs.db
137 | Thumbs.db
138 |
139 | # Build outputs
140 | build/
141 | dist/
142 |
--------------------------------------------------------------------------------
/opsimate-docs/docs/dashboards/overview.md:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 1
3 | ---
4 |
5 | # Dashboard Overview
6 |
7 | The main interface for monitoring and controlling your services.
8 |
9 |
10 |
11 |
OpsiMate main dashboard showing service overview and controls
12 |
13 |
14 | ## Service Control
15 |
16 | Control services directly from the dashboard interface.
17 |
18 |
19 |
20 |
Start/Stop/Restart Services
21 |
Control service lifecycle with one-click actions
22 |
23 |
24 |
Control Services
25 |
Control services with one-click actions
26 |
27 |
28 |
29 |
30 |
31 |
One Ring to rule them all
32 |
Intagrate With all your tools related to your services
33 |
34 |
35 |
Monitor Status
36 |
Real-time service health and performance metrics and logs
41 | We, our service providers and third-party partners use cookies and other
42 | technologies to personalize content, measure usage, support marketing efforts
43 | (including cross-contextual and behavioral targeting advertising efforts) and
44 | provide an optimal experience as permitted by applicable law. Some cookies
45 | are required for the site to function and cannot be turned off. Update your
46 | preferences any time by selecting the "Privacy Choices" link. By accepting,
47 | you agree to the OpsiMate{" "}
48 | Cookie Policy.
49 |
50 |
51 |
52 |
55 |
58 |
59 |
60 |
61 | );
62 | };
63 |
64 | // Wrap in BrowserOnly to avoid SSR issues
65 | export default function CookieConsentWrapper() {
66 | return (
67 |
68 | {() => }
69 |
70 | );
71 | }
--------------------------------------------------------------------------------
/opsimate-docs/sidebars.js:
--------------------------------------------------------------------------------
1 | /**
2 | * Creating a sidebar enables you to:
3 | - create an ordered group of docs
4 | - render a sidebar for each doc of that group
5 | - provide next/previous navigation
6 |
7 | The sidebars can be generated from the filesystem, or explicitly defined here.
8 |
9 | Create as many sidebars as you want.
10 | */
11 |
12 | // @ts-check
13 |
14 | /** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
15 | const sidebars = {
16 | tutorialSidebar: [
17 | 'intro',
18 | 'core-features',
19 | {
20 | type: 'category',
21 | label: 'Getting Started',
22 | collapsed: true,
23 | items: [
24 | 'getting-started/deploy',
25 | 'getting-started/configuration',
26 | 'getting-started/system-requirements',
27 | ],
28 | },
29 | {
30 | type: 'category',
31 | label: 'Providers & Services',
32 | collapsed: true,
33 | items: [
34 | 'providers-services/overview',
35 | {
36 | type: 'category',
37 | label: 'Providers',
38 | collapsed: true,
39 | items: [
40 | 'providers-services/providers/add-provider',
41 | 'providers-services/providers/server-provider',
42 | 'providers-services/providers/kubernetes-provider',
43 | ],
44 | },
45 | {
46 | type: 'category',
47 | label: 'Services',
48 | collapsed: true,
49 | items: [
50 | 'providers-services/services/add-services',
51 | 'providers-services/services/container-services',
52 | 'providers-services/services/systemd-services',
53 | 'providers-services/services/kubernetes-pods',
54 | ],
55 | },
56 | ],
57 | },
58 | {
59 | type: 'category',
60 | label: 'Integrations',
61 | collapsed: true,
62 | items: [
63 | 'integrations/overview',
64 | 'integrations/grafana',
65 | 'integrations/kibana',
66 | 'integrations/datadog',
67 | ],
68 | },
69 | {
70 | type: 'category',
71 | label: 'Dashboard',
72 | collapsed: true,
73 | items: [
74 | 'dashboards/overview',
75 | 'dashboards/service-menu',
76 | 'dashboards/saving-views',
77 | ],
78 | },
79 | {
80 | type: 'category',
81 | label: 'Alerts',
82 | collapsed: true,
83 | items: ['alerts/adding-alerts', 'alerts/alert-management'],
84 | },
85 | {
86 | type: 'category',
87 | label: 'User Management & Security',
88 | collapsed: true,
89 | items: ['user-management/register-login', 'user-management/admin-panel', 'user-management/audit-logs'],
90 | },
91 | 'development',
92 | ],
93 | };
94 |
95 | module.exports = sidebars;
96 |
--------------------------------------------------------------------------------
/opsimate-docs/static/img/datadog.svg:
--------------------------------------------------------------------------------
1 |
4 |
--------------------------------------------------------------------------------
/opsimate-docs/src/components/CookieConsent.css:
--------------------------------------------------------------------------------
1 | /* src/components/CookieConsent.css */
2 | .cookie-consent-banner {
3 | position: fixed;
4 | bottom: 0;
5 | left: 0;
6 | right: 0;
7 | background: #1a1a1a;
8 | color: white;
9 | padding: 1.5rem;
10 | box-shadow: 0 -4px 20px rgba(0, 0, 0, 0.3);
11 | z-index: 1000;
12 | border-top: 1px solid #333;
13 | animation: slideUp 0.3s ease-out;
14 | }
15 |
16 | @keyframes slideUp {
17 | from {
18 | transform: translateY(100%);
19 | }
20 | to {
21 | transform: translateY(0);
22 | }
23 | }
24 |
25 | .cookie-consent-content {
26 | max-width: 1200px;
27 | margin: 0 auto;
28 | display: flex;
29 | justify-content: space-between;
30 | align-items: center;
31 | gap: 2rem;
32 | }
33 |
34 | .cookie-text {
35 | flex: 1;
36 | }
37 |
38 | .cookie-text h4 {
39 | margin: 0 0 0.5rem 0;
40 | color: #bbdefb;
41 | font-size: 1.1rem;
42 | font-weight: 600;
43 | }
44 |
45 | .cookie-text p {
46 | margin: 0;
47 | font-size: 0.9rem;
48 | line-height: 1.5;
49 | color: #e3f2fd;
50 | }
51 |
52 | .cookie-text a {
53 | color: #bbdefb;
54 | text-decoration: underline;
55 | transition: color 0.2s ease;
56 | }
57 |
58 | .cookie-text a:hover {
59 | color: #90caf9;
60 | }
61 |
62 | .cookie-actions {
63 | display: flex;
64 | gap: 1rem;
65 | flex-shrink: 0;
66 | }
67 |
68 | .cookie-btn {
69 | padding: 0.75rem 1.5rem;
70 | border: none;
71 | border-radius: 6px;
72 | font-weight: 600;
73 | cursor: pointer;
74 | transition: all 0.3s ease;
75 | font-size: 0.9rem;
76 | min-width: 120px;
77 | }
78 |
79 | .cookie-btn-reject {
80 | background: transparent;
81 | color: #bbdefb;
82 | border: 1px solid #bbdefb;
83 | }
84 |
85 | .cookie-btn-reject:hover {
86 | background: rgba(187, 222, 251, 0.1);
87 | transform: translateY(-1px);
88 | }
89 |
90 | .cookie-btn-accept {
91 | background: #3949ab;
92 | color: white;
93 | border: 1px solid #3949ab;
94 | }
95 |
96 | .cookie-btn-accept:hover {
97 | background: #303f9f;
98 | border-color: #303f9f;
99 | transform: translateY(-1px);
100 | }
101 |
102 | /* Responsive design */
103 | @media (max-width: 996px) {
104 | .cookie-consent-content {
105 | flex-direction: column;
106 | text-align: center;
107 | gap: 1.5rem;
108 | }
109 |
110 | .cookie-actions {
111 | width: 100%;
112 | justify-content: center;
113 | }
114 | }
115 |
116 | @media (max-width: 768px) {
117 | .cookie-consent-banner {
118 | padding: 1rem;
119 | }
120 |
121 | .cookie-actions {
122 | flex-direction: column;
123 | gap: 0.75rem;
124 | }
125 |
126 | .cookie-btn {
127 | width: 100%;
128 | max-width: 200px;
129 | }
130 | }
131 |
132 | @media (max-width: 480px) {
133 | .cookie-text h4 {
134 | font-size: 1rem;
135 | }
136 |
137 | .cookie-text p {
138 | font-size: 0.85rem;
139 | }
140 |
141 | .cookie-btn {
142 | padding: 0.6rem 1.2rem;
143 | font-size: 0.85rem;
144 | }
145 | }
--------------------------------------------------------------------------------
/opsimate-docs/static/img/kubernetes.svg:
--------------------------------------------------------------------------------
1 |
4 |
--------------------------------------------------------------------------------
/opsimate-docs/blog/2019-05-29-long-blog-post.md:
--------------------------------------------------------------------------------
1 | ---
2 | slug: long-blog-post
3 | title: Long Blog Post
4 | authors: yangshun
5 | tags: [hello, docusaurus]
6 | ---
7 |
8 | This is the summary of a very long blog post,
9 |
10 | Use a `` comment to limit blog post size in the list view.
11 |
12 |
13 |
14 | Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
15 |
16 | Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
17 |
18 | Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
19 |
20 | Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
21 |
22 | Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
23 |
24 | Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
25 |
26 | Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
27 |
28 | Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
29 |
30 | Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
31 |
32 | Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
33 |
34 | Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
35 |
36 | Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
37 |
38 | Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
39 |
40 | Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
41 |
42 | Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
43 |
44 | Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
45 |
--------------------------------------------------------------------------------
/opsimate-docs/docs/getting-started/deploy.md:
--------------------------------------------------------------------------------
1 | ---
2 | id: deploy
3 | title: Deploy OpsiMate
4 | sidebar_position: 2
5 | ---
6 |
7 | # Deploy OpsiMate
8 |
9 | OpsiMate is designed for easy deployment using Docker. This guide will walk you through deploying OpsiMate using Docker Compose or Docker run commands.
10 |
11 | :::info Before You Begin
12 | Make sure your system meets the [system requirements](system-requirements) and that Docker is installed and running.
13 | :::
14 |
15 | ## Quick Start (Recommended)
16 |
17 | The easiest way to get started with OpsiMate is using our one-line installation script:
18 |
19 | ```bash
20 | curl -fsSL https://raw.githubusercontent.com/OpsiMate/OpsiMate/main/scripts/start-docker.sh | sh
21 | ```
22 |
23 | This script will:
24 | - Download the latest OpsiMate Docker Compose configuration
25 | - Set up the necessary directories and permissions
26 | - Start OpsiMate using Docker Compose
27 | - Verify that all services are running correctly
28 |
29 | :::tip What happens next?
30 | Once the script completes, OpsiMate will be running at `http://localhost:8080`. You'll be able to register your first admin user and start managing your infrastructure right away!
31 | :::
32 |
33 | ## Alternative Deployment Methods
34 |
35 | If you prefer more control over your deployment or need to customize the setup, you can use the Docker run command below.
36 |
37 | ### Docker Run Command
38 |
39 | Deploy OpsiMate with a single Docker command:
40 |
41 | ```bash
42 | docker run -d \
43 | --name opsimate \
44 | --rm \
45 | -p 3001:3001 -p 8080:8080 \
46 | opsimate/opsimate
47 | ```
48 |
49 | ### Volume Mounts
50 |
51 | | Volume | Purpose |
52 | |--------|---------|
53 | | `/app/data/database` | SQLite database persistence |
54 | | `/app/data/private-keys` | SSH private keys for authentication |
55 | | `/app/config/config.yml` | Custom configuration |
56 |
57 | :::success
58 | OpsiMate is now running at `http://localhost:8080`
59 | Register a user for the first time - it will be the first admin user
60 | :::
61 |
62 | ### Verify Deployment
63 |
64 | ```bash
65 | # Check container status
66 | docker ps | grep opsimate
67 |
68 | # View application logs
69 | docker logs opsimate
70 |
71 | # Check health status
72 | curl http://localhost:8080/health
73 | ```
74 |
75 | ## First Login
76 |
77 | When you first access OpsiMate at `http://localhost:8080`, you'll be prompted to create your first admin user:
78 |
79 |
80 |
81 | Simply fill in your email, full name, and password to create the initial admin account. This user will have full administrative privileges to configure providers, manage services, and access all OpsiMate features.
82 |
83 | ## Next Steps
84 |
85 | After deployment:
86 |
87 | 1. **Access OpsiMate** at `http://localhost:8080`
88 | 2. **Configure your settings** - [See configuration guide](configuration)
89 | 3. **Check system requirements** - [System requirements](system-requirements)
90 |
91 | ## Support
92 |
93 | If you encounter issues during deployment:
94 |
95 | - Check the [configuration guide](configuration)
96 | - Join our [community discussions](https://github.com/opsimate/opsimate/discussions)
97 | - Report bugs on [GitHub Issues](https://github.com/opsimate/opsimate/issues)
98 |
--------------------------------------------------------------------------------
/opsimate-docs/docs/dashboards/service-menu.md:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 2
3 | ---
4 |
5 | # Service Menu
6 |
7 | Access service-specific options and controls through the right-side menu.
8 |
9 | ## Accessing the Service Menu
10 |
11 | Click on any service in the dashboard to open the service-specific menu panel.
12 |
13 |
14 |
15 |
Service menu sidebar with detailed controls and information
16 |
17 |
18 |
19 |
20 |
Service Details
21 |
View comprehensive service information and status
22 |
23 |
24 |
Quick Actions
25 |
Start, stop, restart, and manage services
26 |
27 |
28 |
29 | ## Menu Options
30 |
31 | ### Service Control
32 | - **Start Service**: Activate inactive services
33 | - **Stop Service**: Gracefully stop running services
34 | - **Restart Service**: Restart services to resolve issues
35 | - **Force Stop**: Emergency service termination
36 |
37 | ### Monitoring & Alerts
38 | - **Configure Alerts**: Set up service-specific notifications
39 | - **View Metrics**: Access detailed performance data
40 | - **Health Checks**: Configure and view service health status
41 | - **Threshold Settings**: Set resource usage alerts
42 |
43 | ### Logs & Diagnostics
44 | - **View Logs**: Access real-time service logs
45 | - **Download Logs**: Export log files for analysis
46 | - **Log Filtering**: Search and filter log entries
47 | - **Error Analysis**: Identify and analyze service errors
48 |
49 | ### Service Configuration
50 | - **Edit Settings**: Modify service configuration
51 | - **Environment Variables**: Manage service environment
52 | - **Resource Limits**: Set CPU and memory constraints
53 | - **Dependency Management**: Configure service dependencies
54 |
55 | ### Tags & Organization
56 | - **Add Tags**: Label services for better organization
57 | - **Edit Description**: Update service descriptions
58 | - **Group Assignment**: Assign services to logical groups
59 | - **Priority Settings**: Set service monitoring priority
60 |
61 | ## Context-Sensitive Options
62 |
63 | Menu options adapt based on service type and current status.
64 |
65 | ### For Running Services
66 | - Stop and restart options available
67 | - Real-time metrics and logs accessible
68 | - Performance monitoring active
69 |
70 | ### For Stopped Services
71 | - Start option prominently displayed
72 | - Configuration editing enabled
73 | - Historical data available
74 |
75 | ### Service Type Specific
76 | - **Systemd Services**: Systemctl command options
77 | - **Docker Containers**: Container management commands
78 | - **Kubernetes Pods**: Kubectl operations and namespace management
79 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 |
OpsiMate - documentation repo!
2 |
The official documentation of OpsiMate - https://opsimate.vercel.app/
3 |
One console for servers, Docker, and Kubernetes—discover, monitor, and act.
4 |
5 | Built for DevOps/NOC/IT teams that need a single place to see service health,
6 | jump to dashboards, and perform safe start/stop/restart operations.
7 |
81 |
82 | ## 💖 Our Amazing Contributors
83 |
84 | This project wouldn’t be what it is today without the incredible people who have shared their time, knowledge, and creativity.
85 | A huge thank you to everyone who has helped and continues to help make OpsiMate better every day! 🙌
86 |
87 |
88 |
89 |
90 |
91 | ---
92 |
--------------------------------------------------------------------------------
/opsimate-docs/docs/providers-services/overview.md:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 1
3 | ---
4 |
5 | # Providers & Services Overview
6 |
7 | Understanding the relationship between providers and services is key to effectively using OpsiMate for infrastructure monitoring.
8 |
9 | ## What are Providers?
10 |
11 | **Providers** are the infrastructure platforms where your applications run. Think of them as the "containers" that host your services:
12 |
13 |
14 |
15 |
🖥️ Server Provider
16 |
A single server or VM that hosts multiple services
39 |
40 | ## What are Services?
41 |
42 | **Services** are the core applications and processes within your system—delivering value or enabling critical capabilities, not necessarily only for end‑users. These are the components you need to both monitor and control to ensure smooth operation and effective management.
43 |
44 | ### Service Types
45 |
46 |
10 | 
11 | 
22 | 
22 | 
25 | 
12 | 
34 | 
29 | 
53 | 
11 | 
80 |
81 | Simply fill in your email, full name, and password to create the initial admin account. This user will have full administrative privileges to configure providers, manage services, and access all OpsiMate features.
82 |
83 | ## Next Steps
84 |
85 | After deployment:
86 |
87 | 1. **Access OpsiMate** at `http://localhost:8080`
88 | 2. **Configure your settings** - [See configuration guide](configuration)
89 | 3. **Check system requirements** - [System requirements](system-requirements)
90 |
91 | ## Support
92 |
93 | If you encounter issues during deployment:
94 |
95 | - Check the [configuration guide](configuration)
96 | - Join our [community discussions](https://github.com/opsimate/opsimate/discussions)
97 | - Report bugs on [GitHub Issues](https://github.com/opsimate/opsimate/issues)
98 |
--------------------------------------------------------------------------------
/opsimate-docs/docs/dashboards/service-menu.md:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 2
3 | ---
4 |
5 | # Service Menu
6 |
7 | Access service-specific options and controls through the right-side menu.
8 |
9 | ## Accessing the Service Menu
10 |
11 | Click on any service in the dashboard to open the service-specific menu panel.
12 |
13 | 
15 | 
12 | 
15 | 
18 | 
21 | 
24 | 
37 | 
59 | 
65 | 
84 | 
90 | 
96 | 
102 | 
108 | 
114 | 
161 |