{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","params":[],"results":{"codes":[]},"settings":""},"next":{"description":"","pages":[]},"title":"Installation","type":"basic","slug":"installation","excerpt":"Installing Orchestra Platform","body":"[block:api-header]\n{\n \"type\": \"basic\",\n \"title\": \"Install Composer\"\n}\n[/block]\nOrchestra Platform utilise [Composer](http://getcomposer.org/) to manage its dependencies. So, before using Orchestra Platform, you will need to make sure you have Composer installed on your machine.\n[block:api-header]\n{\n \"type\": \"basic\",\n \"title\": \"Install Orchestra Platform\"\n}\n[/block]\nYou can install Orchestra Platform using Composer:\n[block:code]\n{\n \"codes\": [\n {\n \"code\": \"composer create-project orchestra/platform 3.3.x --prefer-dist --stability=dev\",\n \"language\": \"text\",\n \"name\": \"Terminal\"\n }\n ]\n}\n[/block]\nThis command would generate the basic application skeleton and prepare all the dependencies that you would need to use to begin developing with Orchestra Platform.\n\n### Environment Setup\n\nBefore moving forward, it would be best to ensure that the environment file `.env` is properly configured.\n\n* Make sure that `APP_KEY` and `APP_ENV` are configured.\n* Update database connection and credential.\n* Ensure both `storage` and `bootstrap/cache` folders are writable by the web server.\n[block:callout]\n{\n \"type\": \"info\",\n \"title\": \"Generate Application Key\",\n \"body\": \"You can generate application key by running the following command:\\n\\n```\\nphp artisan key:generate\\n```\"\n}\n[/block]\n\n[block:api-header]\n{\n \"type\": \"basic\",\n \"title\": \"Install Application\"\n}\n[/block]\nOnce Orchestra Platform `.env` file is properly configured, we need to run the installation and create the application basic schema (including the creation of administrator user).\n\n* Run `php artisan serve` or use your preferred web server stack or Vagrant (Homestead etc).\n* Browse to the installation page, for example `http://localhost:8000/admin` and follow the installation process.\n[block:image]\n{\n \"images\": [\n {\n \"image\": [\n \"https://files.readme.io/LVlUzXk0QeneUdkkKzDv_13497534_10154276507395477_1885548789363025837_o.jpg\",\n \"13497534_10154276507395477_1885548789363025837_o.jpg\",\n \"2032\",\n \"1169\",\n \"\",\n \"\"\n ],\n \"caption\": \"System Requirement\"\n }\n ]\n}\n[/block]\n\n[block:image]\n{\n \"images\": [\n {\n \"image\": [\n \"https://files.readme.io/UoDJ6rKT3OFt8xve0lj2_13497898_10154276507385477_3300472682611011871_o.jpg\",\n \"13497898_10154276507385477_3300472682611011871_o.jpg\",\n \"2032\",\n \"1169\",\n \"\",\n \"\"\n ],\n \"caption\": \"Setup User and Application\"\n }\n ]\n}\n[/block]\n\n[block:image]\n{\n \"images\": [\n {\n \"image\": [\n \"https://files.readme.io/C2zWvkd7TLiZ98TpdUuk_13497597_10154276507400477_2531041865998309794_o.jpg\",\n \"13497597_10154276507400477_2531041865998309794_o.jpg\",\n \"2032\",\n \"1169\",\n \"\",\n \"\"\n ],\n \"caption\": \"Completed\"\n }\n ]\n}\n[/block]\n\n[block:api-header]\n{\n \"type\": \"basic\",\n \"title\": \"Installation Status\"\n}\n[/block]\nYou can check Orchestra Platform installation status from anywhere in the application by running the following code:\n[block:code]\n{\n \"codes\": [\n {\n \"code\": \"<?php\\n\\nuse Orchestra\\\\Support\\\\Facades\\\\Foundation;\\n\\nif (Foundation::installed()) {\\n\\t// execute this code only when Orchestra Platform is installed.\\n}\",\n \"language\": \"php\"\n }\n ]\n}\n[/block]","updates":[],"order":0,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"576ec3e3560eef0e00cd3090","project":"576ebdb79c84a31900958aba","parentDoc":null,"version":{"version":"3.3","version_clean":"3.3.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["576ebdb79c84a31900958abe","576ebfc59c84a31900958ac4","576ec32f52f96619007cfb9a","576ec7b7560eef0e00cd3096","576ed4249c84a31900958add","576ed429560eef0e00cd30a3","576ed43a52f96619007cfbb5","576ed44d5a8c72170082b794","577212f20da40019004f0816","57725c7e0a6d610e00de9e4c"],"_id":"576ebdb79c84a31900958abd","project":"576ebdb79c84a31900958aba","releaseDate":"2016-06-25T17:21:59.854Z","__v":10,"createdAt":"2016-06-25T17:21:59.854Z"},"__v":27,"githubsync":"","createdAt":"2016-06-25T17:48:19.894Z","user":"576ebd239c84a31900958ab9","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Getting Started","slug":"support","order":2,"from_sync":false,"reference":false,"_id":"576ec32f52f96619007cfb9a","__v":0,"createdAt":"2016-06-25T17:45:19.203Z","project":"576ebdb79c84a31900958aba","version":"576ebdb79c84a31900958abd"}}
Installation
Installing Orchestra Platform