All features:
Due to major issues with both versions, we've decided to come back to v12 and recontinue it The latest versions will be on v12 now
We cannot force you to keep the "Powered by Heliactyl" in the footer, but please consider keeping it. It helps getting more visibility to the project and so getting better. We won't do technical support for installations without the notice in the footer. We may DMCA the website in certain conditions. Please do keep the footer though.
Warning: You need Pterodactyl already set up on a domain for this method to work
1.1 Upload the file above onto a Pterodactyl NodeJS server Download the egg from Parkervcp's GitHub Repository
1.2 Unarchive the file and set the server to use NodeJS 16
1.1 Install nodejs16, it's recommended to install it with nvm :
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.3/install.sh | bash
nvm install 16
node -v
and switch between versions with nvm use <version>
1.2 Download heliactyl files in /var/www/heliactyl :
git clone https://github.com/OpenHeliactyl/Heliactyl.git /var/www/heliactyl
1.3 Installing required node modules (and build dependencies to avoid errors) :
apt-get update && apt-get install libcairo2-dev libpango1.0-dev libjpeg-dev libgif-dev librsvg2-dev build-essential
cd /var/www/heliactyl && npm i
After configuring settings.json, to start the server use node index.js
To run in the background use pm2 (see pm2 section) or screen
screen -S heliactyl node index.js
To detach from the screen do ctrl + A + D
To reatach screen -R heliactyl
To stop ctrl + C
2.1 Configure settings.json (specifically panel domain/apikey and discord auth settings for it to work)
2.2 Start the server (Ignore the 2 strange errors that might come up)
2.3 Login to your DNS manager, point the domain you want your dashboard to be hosted on to your VPS IP address. (Example: dashboard.domain.com 192.168.0.1)
2.4 Run apt install nginx && apt install certbot
on the vps
2.5 Run ufw allow 80
and ufw allow 443
on the vps
2.6 Run certbot certonly -d <Your Heliactyl Domain>
then do 1 and put your email
2.7 Run nano /etc/nginx/sites-enabled/heliactyl.conf
2.8 Paste the configuration at the bottom of this and replace with the IP of the pterodactyl server including the port and with the domain you want your dashboard to be hosted on.
2.9 Run systemctl restart nginx
and try open your domain.
server {
listen 80;
server_name <domain>;
return 301 https://$server_name$request_uri;
}
server {
listen 443 ssl http2;
location /afkwspath {
proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection "upgrade";
proxy_pass "http://localhost:<port>/afkwspath";
}
server_name <domain>;
ssl_certificate /etc/letsencrypt/live/<domain>/fullchain.pem;
ssl_certificate_key /etc/letsencrypt/live/<domain>/privkey.pem;
ssl_session_cache shared:SSL:10m;
ssl_protocols SSLv3 TLSv1 TLSv1.1 TLSv1.2;
ssl_ciphers HIGH:!aNULL:!MD5;
ssl_prefer_server_ciphers on;
location / {
proxy_pass http://localhost:<port>/;
proxy_buffering off;
proxy_set_header X-Real-IP $remote_addr;
}
}
From Heliactyl v11/v13 or Dashactyl v0.4 to Heliactyl v12:
From Heliactyl v15:
Move to a newer Heliactyl v12 release:
Installing pm2:
npm install pm2 -g
on the serverStarting the Dashboard in Background:
cd
command, Example: cd /var/www/heliactyl
pm2 start index.js --name "heliactyl"
pm2 logs Heliactyl
Making the dashboard runs on startup:
pm2 list
pm2 startup
and pm2 save
systemd
, upstart
, launchd
, rc.d
pm2 unstartup
To stop a currently running Heliactyl instance, use pm2 stop heliactyl
Heliactyl v6, v7, v8, v9, v10, v11, v13, v15 is now deprecated as listed in our Discord and should not be used. Please update to Heliactyl v12.