{"__v":86,"_id":"55d3b64bf77e6d0d00b1b2a6","category":{"__v":6,"_id":"55d3b645f77e6d0d00b1b27b","pages":["55d3b64bf77e6d0d00b1b2a6","55d3b64bf77e6d0d00b1b2a7","55d78faf60fc730d00fc2839","565cc898687b0d0d004101e4","565ccbcdf8bc860d006842ee","56eb25fa450cf10e00de5675","56eb5d051633510e00f884b2"],"project":"55c505b41469ad2500fa2ab7","version":"55d3b644f77e6d0d00b1b273","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-08-10T18:45:16.066Z","from_sync":false,"order":2,"slug":"agent","title":"Agent"},"parentDoc":null,"project":"55c505b41469ad2500fa2ab7","user":"55c50f4a7c199a2f00665cbf","version":{"__v":6,"_id":"55d3b644f77e6d0d00b1b273","project":"55c505b41469ad2500fa2ab7","createdAt":"2015-08-18T22:48:36.632Z","releaseDate":"2015-08-18T22:48:36.632Z","categories":["55d3b645f77e6d0d00b1b274","55d3b645f77e6d0d00b1b275","55d3b645f77e6d0d00b1b276","55d3b645f77e6d0d00b1b277","55d3b645f77e6d0d00b1b278","55d3b645f77e6d0d00b1b279","55d3b645f77e6d0d00b1b27a","55d3b645f77e6d0d00b1b27b","55d3b645f77e6d0d00b1b27c","55d3b645f77e6d0d00b1b27d","55d7c2939510f00d007ec6fe","56fac9925df15a20002972a2","56fb2f7668e1d30e00a0b672","583498d411e8af2500f6b334","58e52a180ab7b03b00f4a97a"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"1.1.0","version":"1.1"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-08-10T20:14:43.109Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"Neptune requires you to install a lightweight agent on your servers to execute runbooks. We support both cloud and on-premise servers.\n\n## Step 1 : Run a one-line agent installation command on your server as root or Admin user (Windows).\n* In your Servers page, click \"Add agent to your server\" button and that gives a dialog which contains a one-line agent installation command with your Neptune API key pre-populated for different platforms. You need to run the command on your servers as root or Admin user on Windows.\n\n* However, for better security, Neptune agent never runs as root. It runs as 'neptune' user on *NIX machines.\n\n* To install agent as a different user, please change the AGENT_USER variable in the one-line command for *NIX users. For Windows, just run the one-liner as whatever user you want the agent to run as.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/Iw5el26DQR2iVzBuvnpF_Install_Agent.png\",\n        \"Install_Agent.png\",\n        \"1645\",\n        \"881\",\n        \"#3d0524\",\n        \"\"\n      ],\n      \"caption\": \"One-liner command for Neptune agent installation.\"\n    }\n  ]\n}\n[/block]\n## Chef based deployment to multiple linux servers \n\nPlease refer to our github repository [chef-neptune-agent](https://github.com/neptuneio/chef-neptune-agent) for instructions. Puppet recipe is coming soon.\n\n## Bash script to deploy agent to multiple servers\n\nIf you don't use chef or puppet, you can use this [simple shell script](https://raw.githubusercontent.com/neptuneio/neptune-agent/master/scripts/linux/mass_deployment.sh) to deploy agent to multiple AWS EC2 machines using ssh.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"For agent un-installation, updates, sudo priveleges and other administration activites\",\n  \"body\": \"Please refer to [Agent administration ](doc:agent-administration) or [Sudo priveleges](doc:sudo-priveleges-control) sections\"\n}\n[/block]\n## Step 2 : Check if agents are running correctly on your servers\n\nClick agent status tab in your left sidebar to see all the servers with Neptune agents running. If you don't see any servers listed,  or if you find any errors in the logs, please contact our support team by clicking chat window in the lower right corner, or email <support:::at:::neptune.io>\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/kOov9OQxRSa8DyeB8Oaz_agent_status.png\",\n        \"agent_status.png\",\n        \"1507\",\n        \"886\",\n        \"#7b0c44\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"success\",\n  \"title\": \"Congrats ! You have successfully installed Neptune agent. Now learn how to manage the agent\",\n  \"body\": \"[Next : Agent administration](doc:agent-administration)\"\n}\n[/block]","excerpt":"","slug":"agent-installation","type":"basic","title":"Installation"}
Neptune requires you to install a lightweight agent on your servers to execute runbooks. We support both cloud and on-premise servers. ## Step 1 : Run a one-line agent installation command on your server as root or Admin user (Windows). * In your Servers page, click "Add agent to your server" button and that gives a dialog which contains a one-line agent installation command with your Neptune API key pre-populated for different platforms. You need to run the command on your servers as root or Admin user on Windows. * However, for better security, Neptune agent never runs as root. It runs as 'neptune' user on *NIX machines. * To install agent as a different user, please change the AGENT_USER variable in the one-line command for *NIX users. For Windows, just run the one-liner as whatever user you want the agent to run as. [block:image] { "images": [ { "image": [ "https://files.readme.io/Iw5el26DQR2iVzBuvnpF_Install_Agent.png", "Install_Agent.png", "1645", "881", "#3d0524", "" ], "caption": "One-liner command for Neptune agent installation." } ] } [/block] ## Chef based deployment to multiple linux servers Please refer to our github repository [chef-neptune-agent](https://github.com/neptuneio/chef-neptune-agent) for instructions. Puppet recipe is coming soon. ## Bash script to deploy agent to multiple servers If you don't use chef or puppet, you can use this [simple shell script](https://raw.githubusercontent.com/neptuneio/neptune-agent/master/scripts/linux/mass_deployment.sh) to deploy agent to multiple AWS EC2 machines using ssh. [block:callout] { "type": "info", "title": "For agent un-installation, updates, sudo priveleges and other administration activites", "body": "Please refer to [Agent administration ](doc:agent-administration) or [Sudo priveleges](doc:sudo-priveleges-control) sections" } [/block] ## Step 2 : Check if agents are running correctly on your servers Click agent status tab in your left sidebar to see all the servers with Neptune agents running. If you don't see any servers listed, or if you find any errors in the logs, please contact our support team by clicking chat window in the lower right corner, or email <support@neptune.io> [block:image] { "images": [ { "image": [ "https://files.readme.io/kOov9OQxRSa8DyeB8Oaz_agent_status.png", "agent_status.png", "1507", "886", "#7b0c44", "" ] } ] } [/block] [block:callout] { "type": "success", "title": "Congrats ! You have successfully installed Neptune agent. Now learn how to manage the agent", "body": "[Next : Agent administration](doc:agent-administration)" } [/block]