Server Manager
Are you sick of having to log into hundreads of different website just to access your server? Well we got you, Server manager is a open source project made for people so that they can add the servers to one single place irrespective of their provider and manage it through one location. Feel free to setup a local instance of this, would be helpful to manage servers.
Supported softwares
| ID | Softwares | Supported |
|---|---|---|
| 1 | Virtualizor | Yes |
| 2 | Pterodactyl | Yes |
Installation
The below installation steps are for Ubuntu OS only. Refer to other guides for installation on different OS.
Dependencies
APT Update
apt-get update && apt-get -y upgrade
Curl (used in several places during installation)
apt-get -y install curl
Installed apt-add-repository
apt -y install software-properties-common curl apt-transport-https ca-certificates gnupg
Add Ondřej Surý PPA repository
LC_ALL=C.UTF-8 add-apt-repository -y ppa:ondrej/php
Add Chris-lea redis server repository
add-apt-repository -y ppa:chris-lea/redis-server
Download mariadb setup and install it
curl -sS https://downloads.mariadb.com/MariaDB/mariadb_repo_setup | sudo bash
Install Dependencies
apt -y install php8.0 php8.0-{cli,gd,mysql,pdo,mbstring,tokenizer,bcmath,xml,fpm,curl,zip} mariadb-server nginx tar unzip git redis-server npm
Composer
curl -sS https://getcomposer.org/installer | sudo php -- --install-dir=/usr/local/bin --filename=composer
Downloading files
mkdir -p /var/www/manager
cd /var/www/manager
git clone https://github.com/RyderAsKing/ServerManager.git ./
chmod -R 755 storage/* bootstrap/cache/
Storage setup, Key setup, Packages install using composer and NPM
# Copy .env.example to .env
cp .env.example .env
# Composer install
composer install --no-dev --optimize-autoloader
# NPM install
npm install express express-ws ws axios
# Only run the command below if you are installing this Panel for the first time
php artisan key:generate --force
# You should create a symbolic link from public/storage to storage/app/public
php artisan storage:link
Database Setup
Login as root
mysql -u root -p
Create database, user and grant all privileges
CREATE DATABASE servermanager;
CREATE USER 'servermanager'@'127.0.0.1' IDENTIFIED BY 'USE_YOUR_OWN_PASSWORD';
GRANT ALL PRIVILEGES ON *.* TO 'servermanager'@'127.0.0.1' WITH GRANT OPTION;
FLUSH PRIVILEGES;
Configuration
Note that you can ignore PRIVATE_KEY, CERTIFICATE and CHAIN if not using HTTPS.
nano .env
#Example .env vars
APP_NAME=ServerManager
APP_URL="http://yourdomain.com"
WEBSOCKET_TYPE="ws://"
WEBSOCKET_DOMAIN="yourdomain.com"
WEBSOCKET_PORT="3000"
PRIVATE_KEY="/etc/letsencrypt/live/yourdomain.com/privkey.pem"
CERTIFICATE="/etc/letsencrypt/live/yourdomain.com/cert.pem"
CHAIN="/etc/letsencrypt/live/yourdomain.com/chain.pem"
DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=servermanager
DB_USERNAME=servermanager
DB_PASSWORD=USE_YOUR_OWN_PASSWORD
Installing tables and setting up permission
php artisan migrate --seed --force
chown -R www-data:www-data /var/www/manager/*
Example NGINX Config
nano /etc/nginx/sites-available/manager.conf
# Paste the code below in the file and then save and exit
server {
listen 80;
root /var/www/manager/public;
index index.php index.html index.htm index.nginx-debian.html;
server_name yourdomain.com; # Change this
location / {
try_files $uri $uri/ /index.php?$query_string;
}
location ~ \.php$ {
include snippets/fastcgi-php.conf;
fastcgi_pass unix:/var/run/php/php8.0-fpm.sock;
}
location ~ /\.ht {
deny all;
}
}
# Enable NGINX Config
# You do not need to symlink this file if you are using CentOS.
sudo ln -s /etc/nginx/sites-available/manager.conf /etc/nginx/sites-enabled/manager.conf
# Check for nginx errors
sudo nginx -t
# You need to restart nginx regardless of OS. only do this you haven't received any errors
systemctl restart nginx
SSL (Optional but recommended)
# Make sure you have python3 installed
sudo add-apt-repository ppa:certbot/certbot
sudo apt-get update
sudo apt-get install python3-certbot-nginx
sudo certbot --nginx -d yourdomain.com
Finishing up
Congratulations, you are now running a instance of server manager on your server.
Updating
Enable Maintenance Mode
cd /var/www/manager
sudo php artisan down
Downloading new files
sudo git stash
sudo git pull
sudo chmod -R 755 /var/www/manager
Updating database
sudo php artisan migrate --seed --force
Clear cache
sudo php artisan view:clear
sudo php artisan config:clear
Updating dependencies
sudo composer install --no-dev --optimize-autoloader
npm install express express-ws ws axios
Updating permissions
sudo chown -R www-data:www-data /var/www/manager/*
Restarting queue workers
sudo php artisan queue:restart
Disable maintenance mode
sudo php artisan up
Debugging
Get the past 100 logs
tail -n 100 /var/www/manager/storage/logs/laravel.log | nc termbin.com 9999
Paste the URL in the support discord server at https://discord.gg/6ET3NPYn3a
Do note that this is a open source project and we are not obligated to provide support.
Finishing up
Congratulations, you have successfully updated and are now running the latest instance of server manager on your server.
Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
License
The MIT License (MIT)
Copyright (c) 2021 Server Manager by Ryder Asking
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
2.8k Jan 6, 2023
1 Aug 14, 2022
11 May 10, 2022
1.1k Dec 22, 2022
6 Oct 21, 2022
2 Jun 20, 2022
1 Jan 20, 2022
2 Oct 14, 2021
1 Jan 4, 2022
223 Jan 5, 2023
3.5k Jan 7, 2023
101 Oct 19, 2022
6 Dec 15, 2022
1 Jan 15, 2022
6.2k Jan 5, 2023
11 May 22, 2022
3k Jan 5, 2023
34 Sep 17, 2022
3.4k Dec 30, 2022