{"_id":"5c420dff52557b00455096bd","category":{"_id":"5c420dff52557b00455096bb","version":"5c420dff52557b00455096c1","project":"54e78caefdabe62500fcdddf","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-02-20T19:36:15.146Z","from_sync":false,"order":0,"slug":"documentation","title":"Documentation"},"parentDoc":null,"user":"54e78c71523b1b2f00e6f321","project":"54e78caefdabe62500fcdddf","version":{"_id":"5c420dff52557b00455096c1","project":"54e78caefdabe62500fcdddf","__v":0,"forked_from":"5b2582f13fd93f0003dd0835","createdAt":"2018-02-05T15:53:13.563Z","releaseDate":"2018-02-05T15:53:13.563Z","categories":["5c420dff52557b00455096bb","5c420dff52557b00455096bc","5b2582f13fd93f0003dd082f","5b258376a03e480003de616e"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.2.5","version":"1.2.5"},"githubsync":"","__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-11-14T18:16:50.554Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"[block:callout]\n{\n  \"type\": \"danger\",\n  \"title\": \"STOP\",\n  \"body\": \"Do not install or attempt to use pufferd on systems running distributions other than `Ubuntu 16.04`, `Ubuntu 18.04`, `Debian 8`, or `CentOS 7`. Other distributions are not supported.\"\n}\n[/block]\nInstalling pufferd is a very easy process with the auto-deployment script built into PufferPanel that automatically installs and configures pufferd with a single command.\n\n###System Requirements:###\n- A VPS or Dedicated server running a clean installation of Ubuntu 16.04, Ubuntu 18.04, Debian 8, or CentOS 7\n- SSH access and administrative (root or sudo) privileges on the server\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Step 1: Add a Node\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Local node already installed\",\n  \"body\": \"The PufferPanel installer automatically installs pufferd locally on the same machine as the panel is running on.\\n\\n**Do not perform these steps unless you need to add another node to PufferPanel!**\"\n}\n[/block]\nOn your PufferPanel installation, add a new node and fill out the information. Once you have successfully added the node, move to the next step.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/bd2afd4-Screen_Shot_2017-05-20_at_10.46.06_PM.png\",\n        \"Screen Shot 2017-05-20 at 10.46.06 PM.png\",\n        1962,\n        664,\n        \"#b1b1b1\"\n      ]\n    }\n  ]\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/fb88032-Screen_Shot_2017-05-20_at_10.45.07_PM.png\",\n        \"Screen Shot 2017-05-20 at 10.45.07 PM.png\",\n        1940,\n        1620,\n        \"#b3b3b3\"\n      ]\n    }\n  ]\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/4a7e936-Screen_Shot_2017-05-20_at_10.42.14_PM.png\",\n        \"Screen Shot 2017-05-20 at 10.42.14 PM.png\",\n        1448,\n        1208,\n        \"#f9f8f8\"\n      ]\n    }\n  ]\n}\n[/block]\n**Make sure to fill in the Node FQDN box correctly. If you do not have a domain, please use the IP of your node.**\n\nNode Private IP should be populated if PufferPanel needs to use a different IP than the one in the Node FQDN box to talk to it. An example of this would be a server behind a network using NAT.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Step 2: Generate Script\"\n}\n[/block]\nGo to the node information page and switch to the 'Auto-Deploy' tab. There will be a button that says `Generate Auto-Deployment Script`, press it. This will update the page to look like the picture below.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/e6000d1-Screen_Shot_2017-05-20_at_10.48.57_PM.png\",\n        \"Screen Shot 2017-05-20 at 10.48.57 PM.png\",\n        1450,\n        1222,\n        \"#f3f5f3\"\n      ]\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Step 3: Login to the Server and Run Script\"\n}\n[/block]\nAfter you have generated the script, simply SSH into the node and paste the command that is listed (`sudo bash -c 'source <(...)'`).\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/jQ2fNqPQTt6JLr0otRgD_Screen%20Shot%202016-01-19%20at%2012.34.41%20PM.png\",\n        \"Screen Shot 2016-01-19 at 12.34.41 PM.png\",\n        \"851\",\n        \"376\",\n        \"#042b33\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"success\",\n  \"body\": \"Congratulations, pufferd is now installed and running. Head back to PufferPanel and add a server!\"\n}\n[/block]","excerpt":"Follow these steps to install the PufferPanel daemon on a remote node.","slug":"getting-started","type":"basic","title":"Installing pufferd"}

Documentation

Templates

Installing pufferd

Follow these steps to install the PufferPanel daemon on a remote node.
[block:callout] { "type": "danger", "title": "STOP", "body": "Do not install or attempt to use pufferd on systems running distributions other than `Ubuntu 16.04`, `Ubuntu 18.04`, `Debian 8`, or `CentOS 7`. Other distributions are not supported." } [/block] Installing pufferd is a very easy process with the auto-deployment script built into PufferPanel that automatically installs and configures pufferd with a single command. ###System Requirements:### - A VPS or Dedicated server running a clean installation of Ubuntu 16.04, Ubuntu 18.04, Debian 8, or CentOS 7 - SSH access and administrative (root or sudo) privileges on the server [block:api-header] { "type": "basic", "title": "Step 1: Add a Node" } [/block] [block:callout] { "type": "warning", "title": "Local node already installed", "body": "The PufferPanel installer automatically installs pufferd locally on the same machine as the panel is running on.\n\n**Do not perform these steps unless you need to add another node to PufferPanel!**" } [/block] On your PufferPanel installation, add a new node and fill out the information. Once you have successfully added the node, move to the next step. [block:image] { "images": [ { "image": [ "https://files.readme.io/bd2afd4-Screen_Shot_2017-05-20_at_10.46.06_PM.png", "Screen Shot 2017-05-20 at 10.46.06 PM.png", 1962, 664, "#b1b1b1" ] } ] } [/block] [block:image] { "images": [ { "image": [ "https://files.readme.io/fb88032-Screen_Shot_2017-05-20_at_10.45.07_PM.png", "Screen Shot 2017-05-20 at 10.45.07 PM.png", 1940, 1620, "#b3b3b3" ] } ] } [/block] [block:image] { "images": [ { "image": [ "https://files.readme.io/4a7e936-Screen_Shot_2017-05-20_at_10.42.14_PM.png", "Screen Shot 2017-05-20 at 10.42.14 PM.png", 1448, 1208, "#f9f8f8" ] } ] } [/block] **Make sure to fill in the Node FQDN box correctly. If you do not have a domain, please use the IP of your node.** Node Private IP should be populated if PufferPanel needs to use a different IP than the one in the Node FQDN box to talk to it. An example of this would be a server behind a network using NAT. [block:api-header] { "type": "basic", "title": "Step 2: Generate Script" } [/block] Go to the node information page and switch to the 'Auto-Deploy' tab. There will be a button that says `Generate Auto-Deployment Script`, press it. This will update the page to look like the picture below. [block:image] { "images": [ { "image": [ "https://files.readme.io/e6000d1-Screen_Shot_2017-05-20_at_10.48.57_PM.png", "Screen Shot 2017-05-20 at 10.48.57 PM.png", 1450, 1222, "#f3f5f3" ] } ] } [/block] [block:api-header] { "type": "basic", "title": "Step 3: Login to the Server and Run Script" } [/block] After you have generated the script, simply SSH into the node and paste the command that is listed (`sudo bash -c 'source <(...)'`). [block:image] { "images": [ { "image": [ "https://files.readme.io/jQ2fNqPQTt6JLr0otRgD_Screen%20Shot%202016-01-19%20at%2012.34.41%20PM.png", "Screen Shot 2016-01-19 at 12.34.41 PM.png", "851", "376", "#042b33", "" ] } ] } [/block] [block:callout] { "type": "success", "body": "Congratulations, pufferd is now installed and running. Head back to PufferPanel and add a server!" } [/block]