{"id":13700248,"url":"https://github.com/serverboards/serverboards","last_synced_at":"2025-05-04T18:34:50.207Z","repository":{"id":57465852,"uuid":"62237113","full_name":"serverboards/serverboards","owner":"serverboards","description":"Serverboards is a microservices based service monitoring, alerting and management system.","archived":true,"fork":false,"pushed_at":"2020-06-19T09:12:42.000Z","size":11358,"stargazers_count":79,"open_issues_count":4,"forks_count":4,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-04-24T04:43:38.120Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://serverboards.io","language":"CSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/serverboards.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-06-29T15:30:44.000Z","updated_at":"2023-10-22T04:53:08.000Z","dependencies_parsed_at":"2022-09-17T18:01:28.461Z","dependency_job_id":null,"html_url":"https://github.com/serverboards/serverboards","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/serverboards%2Fserverboards","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/serverboards%2Fserverboards/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/serverboards%2Fserverboards/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/serverboards%2Fserverboards/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/serverboards","download_url":"https://codeload.github.com/serverboards/serverboards/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252383144,"owners_count":21739282,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-02T20:00:51.935Z","updated_at":"2025-05-04T18:34:45.177Z","avatar_url":"https://github.com/serverboards.png","language":"CSS","funding_links":[],"categories":["CSS","Uncategorized"],"sub_categories":["Uncategorized"],"readme":"# Serverboards\nhttps://serverboards.io\n\n**SERVERBOARDS IS NO LONGER IN DEVELOPMENT. USE AT YOUR OWN RISK OR FORK AND EVOLVE IT**\n\n\nServerboards is a [Service] [Integration] [Platform] that eases the integration of other services.\n\nIt provides all the plumbing necessary to interconnect your services.\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"docs/screenshot1.png\" title=\"Dashboard\"/\u003e\n\u003c/p\u003e\n\n[Service]: https://en.wikipedia.org/wiki/Service_(systems_architecture)\n[Integration]: https://en.wikipedia.org/wiki/System_integration\n[Platform]: https://en.wikipedia.org/wiki/Cloud-based_integration\n\n\n# Example use cases\n\nFor example you can connect to your WordPress database, to Google Analytics, and\nto MailChimp to do a detailed tracking of your mailing campaings on our\nDashboards.\n\nOr automate some webhook connection to the integrated messaging system and\ngoogle drive so all contact requests are archived and sent to the proper actors.\n\nServerboards makes it easy for you to control your IT Infrastructure from a\nsingle dashboard. Servers, virtual machines, websites, databases and more can be\nmonitored or managed in an easy way.\n\n# Main Features\n\n* Services\n* Dashboards\n* Rules\n* Notifications\n* Issues\n* Screens\n* Plugins and [Marketplace]: 25 packages and counting\n\n[Marketplace]: https://serverboards.app/packages/\n\n## Services: Connect to all your services\n\nServerboards main element are services. Once you have configured the access to\nyour services, you can start using them at the dashboards, the screens or the\nrules.\n\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"docs/screenshot2.png\" title=\"Dashboard\"/\u003e\n\u003c/p\u003e\n\nJust by configuring the services you get automatic monitoring and an issue will\nbe generated and the users notified when the service is no longer accessible.\nDepending on the service it may mean different things, as DNS could not be\nresolved, the SSL certificate expired, or the user and password changed. In any\ncase you will know and be able to take corrective measures.\n\n## Dashboards: Monitor the hidden information of your KPIs\n\nDashboards are windows into the data of your infrastructure. It may be a purely\ntechnical one for IT management, or it may be a Marketing oriented with data\nfrom your Google Analytics and Facebook Ads.\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"docs/screenshot1.png\" title=\"Dashboard\"/\u003e\n\u003c/p\u003e\n\nWe use our own USQ technology that allows us to merge information from many\nsources, for example getting the visits from Google Analytics, and merging via\nthe URL to your WordPress installation to show which of your tags are more\npopular.\n\nUniversal Service Query is [our\ntechnology](https://github.com/serverboards/exosql/) that merges data from many\nsources and can be used form a single SQL query. And creating the data\nextractors is a 10 lines of code exercise for the developers.\n\n\n## Rules: Automated work flows made easy with our GUI-based rules composer\n\nEasily monitor your server performance in real time, manage your virtual\nmachines and automate most common infrastructure issues.\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"docs/screenshot6.png\" title=\"Rules\"\u003e\n\u003c/p\u003e\n\n## Notifications: Get notified of the important events wherever you want\n\nServerboards is super extensible. Not extensible, super extensible. Everything\ncan be expanded and built upon. Notifications is no less and its possible to\ncreate components that notify your users however you want.\n\nOf course there is a built in email notification system, and there is a\n[Telegram](https://serverboards.app/packages/serverboards.telegram/) one\non the Marketplace.\n\n## Issues: Built in Issues and Logs with alerting\n\nIf something happens, you can access the traces in our in-built logging solution\nand identify what caused the error.\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"docs/screenshot3.png\" title=\"Alerting\"/\u003e\n\u003c/p\u003e\n\nThere is a log per service that let you see all important actions performed and\nwhen, by you or by packages. All modifications and uses are properly registered.\nAnd errors give meaningful descriptions to be able to diagnose and fix them.\n\n## Screens: Extend Serverboards in ways nobody thought about\n\nFor example Serverboards comes with an embedded SSH terminal. This way console\nactions can be performed from Serverboards itself to troubleshoot faster.\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"docs/screenshot4.png\" title=\"Terminal\"/\u003e\n\u003c/p\u003e\n\nThere are many other screens available: [Spice Remote\nDesktop](https://serverboards.app/packages/serverboards.spice/), [Simple\nbackups](https://serverboards.app/packages/serverboards.optional.backups/),\n[Cloud\nManagement](https://serverboards.app/packages/serverboards.optional.cloud/) and\nmany others.\n\nUsing screens you can use all Serverboards security, users, and connectivity to\ncreate custom back office applications to manage your businesses.\n\n\n## Packages and Marketplace: Plugin based\n\nServerboards is based on simple to develop plugins that do all the small tasks\nlike checking if a service is UP, gathering the information and showing\ninformation to the user, letting Serverboards Core do all the orchestration and\nheavy work.\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"docs/screenshot5.png\" title=\"Alerting\"/\u003e\n\u003c/p\u003e\n\nStarting with 18.10 we created a\n[Marketplace](https://serverboards.app/packages/) that allows users to install\nnew packages from Serverboards itself in the place where they could need it. For\nexample, if they are adding services, it is possible to select them from the\nmarketplace and install them directly from the service add screen.\n\nIn time we want to show developer created applications and packages that can\nbenefit from being in the integration platform, that access all the data they\nneed, and more importantly that are secure.\n\nThere is a full simple to use [API for\ndevelopment](https://serverboards.io/developers/). Once you start using it, you\nwill not believe how easy is to just center on your problem, and forget about\nall the scaffolding normally necessary to create this kind of integrations.\n\n# Get started!\n\n## Install and Download\n\nServerboards can be downloaded to be used on Ubuntu 18.04 (and maybe others) at\nhttps://serverboards.io/downloads/\n\nThere are full instructions about how to start and first steps.\n\nIf you are not using Ubuntu 18.04, please contact us or try the developer\ninstallation instructions.\n\n# Develop!\n\n## Collaborate / Develop with Serverboards\n\nServerboards is licensed under the Apache 2 license, and plugins can be\ndeveloped by third parties using any license. Please refer to\nhttps://serverboards.io/developers/ for more information.\n\n* Issue tracker at [github](https://github.com/serverboards/serverboards/issues)\n* Forums for troubleshooting and hanging around at\n  https://forum.serverboards.io/\n* Subscribe to our newsletter at https://serverboards.io\n\nServerboards uses the [Elixir Language](https://elixir-lang.org/) for the\nbackend, [Python](https://www.python.org) for plugins and\n[JavaScript](https://developer.mozilla.org/en-US/docs/Web/javascript)/[React](https://reactjs.org/)\nfor the frontend and plugins.\n\nTo develop plugins we recommend to use Python and JavaScript/React, but basic\nPython and/or HTML + JS should be enough depending on what you want to achieve.\nContact us if you have any idea and need help to make it work!\n\n## Compiling and running the server\n\nIf you plan to develop Serverboards core itself, first install all\nprerequisites:\n\n* Erlang 20.x\n* Elixir 1.6.x\n\nCheck `scripts/setup-ubuntu-1804.sh` as a guide on what to install and how. It\nworks for Ubuntu 18.04, but should work for others.\n\nThen compile it once to ensure you have all the required dependencies:\n\n```shell\nmake compile\n```\n\nAnd then you may run it executing these commands in two different terminals:\n\nTerminal 1:\n```shell\ncd backend\niex -S mix\n```\n\nTerminal 2:\n```shell\ncd frontend\nnpm start\n```\n\nNow you can connect to the backend at http://localhost:8080 or at the running\nwebpack server at http://localhost:3000 .\n\nIf you connect to the webpack server it is necessary to force the backend URL so\nthat the WebSocket can connect. Open the developer console at the browser (F12\nor Crtl+Shift+C), and write:\n\n```js\nlocalStorage.servername=\"http://localhost:8080\"\n```\n\nAlternatively you can create the release with `make release` and run it as\n`rel/serverboards/bin/serverboards foreground`.\n\n## First time user\n\nThe easiest way to have a first time user is to use\n\n```shell\nexport SERVERBOARDS_DATABASE_URL=\"postgresl://serverboards:serverboards@localhost/serverboards\"\ncli/s10s-user.py create username\ncli/s10s-user.py passwd username password\n```\n\n## Plugin development workflow\n\nTo develop new plugins create a directory or link to your source at\n$SERVERBOARDS_PATH/plugins, which by default is on installed systems at\n`/opt/serverboards/share/serverboards/plugins/`. If you use the development\nversion, it would be at `~/.local/serverboards/plugins/`.\n\nPlugin manifest is normally reloaded automatically upon changes, and commands at\ncommand restart. If it is necessary to force a command execution, you can\nrestart full Serverboards (`sudo service serverboards restart` or restart\nbackend process).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fserverboards%2Fserverboards","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fserverboards%2Fserverboards","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fserverboards%2Fserverboards/lists"}