{"_id":"56ec67de04e8940e009664f2","version":{"_id":"56e4c56ccc9b140e003e86ab","__v":4,"hasDoc":true,"project":"56e4c56bcc9b140e003e86a8","hasReference":true,"createdAt":"2016-03-13T01:42:04.131Z","releaseDate":"2016-03-13T01:42:04.131Z","categories":["56e4c56ccc9b140e003e86ac","56e5e17fd6d5513200761165","56e5e2acd1303329002ea781","56ec6dc12400d20e0075ba21"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"project":"56e4c56bcc9b140e003e86a8","__v":20,"user":"56e4c5462d90970e00af1af3","category":{"_id":"56e5e2acd1303329002ea781","project":"56e4c56bcc9b140e003e86a8","pages":["56ec672c2400d20e0075ba0c","56ec679a3b656b0e00d861d1","56ec67de04e8940e009664f2","56ecc61d849b230e00df43f3","56ecce4c1484f1170021d57d","56ecd4f37f94882900591943"],"version":"56e4c56ccc9b140e003e86ab","__v":6,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-03-13T21:59:08.172Z","from_sync":false,"order":1,"slug":"installation","title":"Administrator Guide"},"githubsync":"","parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-03-18T20:41:02.264Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":1,"body":"Requarks is easy to install. You should be up and running in no time by following the instructions below.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"1. Prerequisites\"\n}\n[/block]\nMake sure you meet all the [prerequisites](doc:prerequisites) before proceeding any further.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"2. Get Requarks\"\n}\n[/block]\n- Download the latest version of Requarks from the [downloads](http://requarks.io/downloads) page or from the [GitHub project releases](https://github.com/Requarks/requarks/releases).\n- Extract the archive to the folder of your choice. The server will run from this path.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"3. Setup Requarks\"\n}\n[/block]\nMake sure Node has the necessary permissions to read / write in Requarks folder.\n\nFrom a command prompt / console, start the server:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"# Run the following command to start Requarks:\\n\\nnode server\\n\\n# You can also specify a specific port:\\n\\nnode server --port 8080\",\n      \"language\": \"shell\"\n    }\n  ]\n}\n[/block]\nRequarks will automatically start in setup mode if no configuration is detected.\n\nIn your browser, navigate to http://localhost/ or the host where the server is located. Requarks listens by default on port 80. You can force it to listen to another port by using the --port argument as shown in the example above.\n\nYou will be presented with a setup page. Fill in the form and click **Save & Install** to complete the installation. Detailed instructions for each section of the setup page can be found below:\n\n- [Database](doc:database)\n- [Storage](doc:storage)\n- [Redis Cache](doc:caching)\n- [Auth0](doc:authentication)\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"4. Run Requarks\"\n}\n[/block]\nOnce the installation is completed, the node process will reload automatically.\n\nIf everything is properly configured, Requarks should be working now. :satisfied:\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Command arguments\"\n}\n[/block]\nYou can use the following command arguments when running the server:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"node server [options]\\n\\n\\t-h, --help\\t\\t\\tOutput usage information\\n  -p, --port <n>\\tPort Requarks run on\\n  -s, --setup\\t\\t\\tForces Requarks to run in setup mode\",\n      \"language\": \"shell\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"install","type":"basic","title":"Installation"}
Requarks is easy to install. You should be up and running in no time by following the instructions below. [block:api-header] { "type": "basic", "title": "1. Prerequisites" } [/block] Make sure you meet all the [prerequisites](doc:prerequisites) before proceeding any further. [block:api-header] { "type": "basic", "title": "2. Get Requarks" } [/block] - Download the latest version of Requarks from the [downloads](http://requarks.io/downloads) page or from the [GitHub project releases](https://github.com/Requarks/requarks/releases). - Extract the archive to the folder of your choice. The server will run from this path. [block:api-header] { "type": "basic", "title": "3. Setup Requarks" } [/block] Make sure Node has the necessary permissions to read / write in Requarks folder. From a command prompt / console, start the server: [block:code] { "codes": [ { "code": "# Run the following command to start Requarks:\n\nnode server\n\n# You can also specify a specific port:\n\nnode server --port 8080", "language": "shell" } ] } [/block] Requarks will automatically start in setup mode if no configuration is detected. In your browser, navigate to http://localhost/ or the host where the server is located. Requarks listens by default on port 80. You can force it to listen to another port by using the --port argument as shown in the example above. You will be presented with a setup page. Fill in the form and click **Save & Install** to complete the installation. Detailed instructions for each section of the setup page can be found below: - [Database](doc:database) - [Storage](doc:storage) - [Redis Cache](doc:caching) - [Auth0](doc:authentication) [block:api-header] { "type": "basic", "title": "4. Run Requarks" } [/block] Once the installation is completed, the node process will reload automatically. If everything is properly configured, Requarks should be working now. :satisfied: [block:api-header] { "type": "basic", "title": "Command arguments" } [/block] You can use the following command arguments when running the server: [block:code] { "codes": [ { "code": "node server [options]\n\n\t-h, --help\t\t\tOutput usage information\n -p, --port <n>\tPort Requarks run on\n -s, --setup\t\t\tForces Requarks to run in setup mode", "language": "shell" } ] } [/block]