BSoDium/Slashboard-pulsar
BSoDium/Slashboard-pulsar has 27 GitHub stars and 0 forks. GitHot measured 0 stars in 24 hours. Last checked 2026-11-16 04:23 UTC. Last push 2023-02-11.
Measured star growth
- in 24h
- 0
- in 7 days
- Collecting history
- in 15 days
- Collecting history
- in 1 month
- Collecting history
Net star changes over overlapping periods, not daily totals. Missing measurements are left blank. Stars measure attention, not software quality.
About
A simple dashboard to keep track of all your active devices/servers
Self-hostedREADME.md
OriginalSlashboard Pulsar
A lightweight node js app designed to work with the Slashboard desktop client
Built using Node.js
Installation
Clone this repository somewhere safe on your server (
/var/wwwis often a good choice)cd /var/www # replace /var/www with the path you prefer if necessary git clone https://github.com/BSoDium/Slashboard-pulsar.gitInstall all the necessary dependencies
cd Slashboard-pulsar npm install
Automated installation (Linux only)
Run the installation script for your OS (only available for linux at the moment)
./scripts/install.shThis script will :
- setup nodejs if necessary
- install pm2 (used to daemonize the app)
- generate a pairing key for your server, which will be later required by the desktop client
- at the end, it will ask you if you want to run Pulsar on system startup (recommended), if you answer yes, the script will give you a command, which you should paste and run in the terminal manually (I am working on automating this, but until now, this is mandatory)
Manual installation (Linux)
Setup pm2 :
npm install pm2 -gChoose an authentification key and a server-specific secret :
nano config/default.jsonBy default, the generated keys are 64 characters long, but you can choose shorter ones. When you'll open the file for the first time, The fields will contain the word "default". Erase it and write your key.
The field
serverKeyis the local server secret, andsharedSecretis the key used by the client to connect to your server. It will be later required when registering the server in the desktop app.Warning : no special characters allowed, only alphanumeric characters. Example :
CRml6VcWMGlH8UQ1XjintL1Tu71IA5ktbA5I8g0HzwrhF4E0hNE50O1ep7W2eNOuAllow traffic through port
6033:sudo ufw allow 6033Start the app :
pm2 start ecosystem.config.js --env productionTell pm2 to run it on system startup :
pm2 startup # execute the command pm2 gives youSave the app list to be restored on reboot :
pm2 save
Manual installation (Windows server)
Download nodejs and npm
Install pm2
npm install pm2 -gInstall pm2-windows-startup
npm install pm2-windows-startup -g pm2-startup installOpen
config/default.jsonwith your favorite editor, delete the default keys and write your own (see linux manual installation for more details).Warning : no special characters allowed, only alphanumeric characters. Example :
CRml6VcWMGlH8UQ1XjintL1Tu71IA5ktbA5I8g0HzwrhF4E0hNE50O1ep7W2eNOuStart the app:
pm2 start ecosystem.config.js --env productionSetup pm2 to relaunch the app on system startup :
pm2 save
Docker installation
Note : This image is still in early access, some features might not fully work as expected.
- Broken on any OS :
- Mounted disks view - the ones displayed don't match the host machine's state
- Broken on Windows :
- Hostname (host network mode doesn't exist on Windows)
- CPU/RAM usage isn't impressively accurate
- Network interface list
Pull the image from the repository, either from github or dockerhub
On Linux :
docker run \ --network host \ --env SHAREDSECRET="64charSharedSecret" BSoDium/slashboard-pulsar:latestSHAREDSECRET is optional. If not provided, it will be randomly generated on container creation.
On Windows :
docker run ` -p 6033:6033 ` --env SHAREDSECRET="64charSharedSecret" ` BSoDium/slashboard-pulsar:latestAgain, SHAREDSECRET isn't required.
Accessing your server from anywhere on the internet
If you want to access your server's dashboard from outside its local network, you will probably need to forward a port in your router's configuration. Here's a quick guide to port forwarding, although I suggest that you look for something more specific, because router configuration really depends on your internet provider.
As for the port you need to forward, Pulsar runs on port 6033 by default (cannot be easily changed for now)
Uninstalling Pulsar
Simply run :
./scripts/uninstall.sh
or :
pm2 delete Pulsar
npm uninstall pm2 -g
sudo ufw delete allow 6033 # linux only