{"_id":"576ec9039c84a31900958ad2","project":"576ebdb79c84a31900958aba","__v":17,"githubsync":"","user":"576ebd239c84a31900958ab9","category":{"_id":"576ec32f52f96619007cfb9a","__v":0,"project":"576ebdb79c84a31900958aba","version":"576ebdb79c84a31900958abd","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-06-25T17:45:19.203Z","from_sync":false,"order":2,"slug":"support","title":"Getting Started"},"parentDoc":null,"version":{"_id":"576ebdb79c84a31900958abd","project":"576ebdb79c84a31900958aba","__v":10,"createdAt":"2016-06-25T17:21:59.854Z","releaseDate":"2016-06-25T17:21:59.854Z","categories":["576ebdb79c84a31900958abe","576ebfc59c84a31900958ac4","576ec32f52f96619007cfb9a","576ec7b7560eef0e00cd3096","576ed4249c84a31900958add","576ed429560eef0e00cd30a3","576ed43a52f96619007cfbb5","576ed44d5a8c72170082b794","577212f20da40019004f0816","57725c7e0a6d610e00de9e4c"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"3.3.0","version":"3.3"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-06-25T18:10:11.040Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":1,"body":"All of the configuration files for the Orchestra Platform are stored in the `resources/config` directory. Each option is documented, so feel free to look through the files and get familiar with the options available to you.\n\nOrchestra Platform needs almost no other configuration out of the box except for database configuration, which can be configured in `.env` file. However, you may wish to review the `resources/config/app.php` file and its documentation. It contains several options such as timezone and locale that you may wish to change according to your application.\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Don't enable debug mode on production\",\n  \"body\": \"You should never have the `app.debug` configuration option set to `true` for a production application.\\n\\n```\\nAPP_DEBUG=false\\n```\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Setting Admin URL\"\n}\n[/block]\nInstead of using the default `/admin` prefix for your administration page, you can configure Orchestra Platform to handled by a different URL, to utilise this feature all you need to do is publish `orchestra/foundation` configuration using the following command:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"php artisan publish:config orchestra/foundation\",\n      \"language\": \"text\",\n      \"name\": \"Terminal\"\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"success\",\n  \"body\": \"This command would publish the configuration file to `resources/config/packages/orchestra/foundation/config.php`.\"\n}\n[/block]\n## URL Prefix\n\nEdit `handles` key in `resources/config/packages/orchestra/foundation/config.php` to (as an example) `\"sudo\"`. With this changes Orchestra Platform Administration page while be accessible from `/sudo`.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<?php\\n\\nreturn [\\n\\t'handles' => 'sudo',\\n];\",\n      \"language\": \"php\",\n      \"name\": \"resources/config/packages/orchestra/foundation/config.php\"\n    }\n  ]\n}\n[/block]\n## URL Domain\n\nYou can also assign a sub-domain to handle Orchestra Platform Administration page by editing the `handles` value to `//admin.{{domain}}`.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<?php\\n\\nreturn [\\n\\t'handles' => '//admin.{{domain}}',\\n];\",\n      \"language\": \"php\",\n      \"name\": \"resources/config/packages/orchestra/foundation/config.php\"\n    }\n  ]\n}\n[/block]\nHowever to do this, please make sure that you have set `APP_URL` value in `.env` and using `Orchestra\\Extension\\Traits\\DomainAware` to allow `{{domain}}` to be resolved dynamically.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<?php namespace App\\\\Providers;\\n\\nuse Illuminate\\\\Support\\\\ServiceProvider;\\nuse Orchestra\\\\Extension\\\\Traits\\\\DomainAware;\\n\\nclass AppServiceProvider extends ServiceProvider\\n{\\n\\tuse DomainAware;\\n\\n\\t/**\\n\\t * Boot the service provider.\\n\\t *\\n\\t * :::at:::return void\\n\\t */\\n\\tpublic function boot()\\n\\t{\\n\\t\\t$this->registerDomainAwareness();\\n\\t}\\n}\",\n      \"language\": \"php\",\n      \"name\": \"app/Providers/AppServiceProvider.php\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Disable Extension for Debugging\"\n}\n[/block]\nThere would be time when you might face problem with Orchestra Platform where an extension might cause a bug and your application stop working. In such event, you can use the safe mode to stop any extension from being loaded during bootstrap.\n\nTo do this, just set `EXTENSION_MODE=safe` to your `.env`. This way, we would create a session data to indicate that you are browsing the site in safe mode. Once you have deactivate any problematic/broken extension just remove the value or change it to `EXTENSION_MODE=normal` to browse the website normally (with extensions re-enabled).\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"EXTENSION_MODE=safe\",\n      \"language\": \"text\",\n      \"name\": \".env\"\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"You can also use `?_mode=safe` (default to `normal`) as URL query string.\",\n  \"title\": \"Disable Extension using the URL\"\n}\n[/block]","excerpt":"","slug":"configuration","type":"basic","title":"Configuration"}
All of the configuration files for the Orchestra Platform are stored in the `resources/config` directory. Each option is documented, so feel free to look through the files and get familiar with the options available to you. Orchestra Platform needs almost no other configuration out of the box except for database configuration, which can be configured in `.env` file. However, you may wish to review the `resources/config/app.php` file and its documentation. It contains several options such as timezone and locale that you may wish to change according to your application. [block:callout] { "type": "warning", "title": "Don't enable debug mode on production", "body": "You should never have the `app.debug` configuration option set to `true` for a production application.\n\n```\nAPP_DEBUG=false\n```" } [/block] [block:api-header] { "type": "basic", "title": "Setting Admin URL" } [/block] Instead of using the default `/admin` prefix for your administration page, you can configure Orchestra Platform to handled by a different URL, to utilise this feature all you need to do is publish `orchestra/foundation` configuration using the following command: [block:code] { "codes": [ { "code": "php artisan publish:config orchestra/foundation", "language": "text", "name": "Terminal" } ] } [/block] [block:callout] { "type": "success", "body": "This command would publish the configuration file to `resources/config/packages/orchestra/foundation/config.php`." } [/block] ## URL Prefix Edit `handles` key in `resources/config/packages/orchestra/foundation/config.php` to (as an example) `"sudo"`. With this changes Orchestra Platform Administration page while be accessible from `/sudo`. [block:code] { "codes": [ { "code": "<?php\n\nreturn [\n\t'handles' => 'sudo',\n];", "language": "php", "name": "resources/config/packages/orchestra/foundation/config.php" } ] } [/block] ## URL Domain You can also assign a sub-domain to handle Orchestra Platform Administration page by editing the `handles` value to `//admin.{{domain}}`. [block:code] { "codes": [ { "code": "<?php\n\nreturn [\n\t'handles' => '//admin.{{domain}}',\n];", "language": "php", "name": "resources/config/packages/orchestra/foundation/config.php" } ] } [/block] However to do this, please make sure that you have set `APP_URL` value in `.env` and using `Orchestra\Extension\Traits\DomainAware` to allow `{{domain}}` to be resolved dynamically. [block:code] { "codes": [ { "code": "<?php namespace App\\Providers;\n\nuse Illuminate\\Support\\ServiceProvider;\nuse Orchestra\\Extension\\Traits\\DomainAware;\n\nclass AppServiceProvider extends ServiceProvider\n{\n\tuse DomainAware;\n\n\t/**\n\t * Boot the service provider.\n\t *\n\t * @return void\n\t */\n\tpublic function boot()\n\t{\n\t\t$this->registerDomainAwareness();\n\t}\n}", "language": "php", "name": "app/Providers/AppServiceProvider.php" } ] } [/block] [block:api-header] { "type": "basic", "title": "Disable Extension for Debugging" } [/block] There would be time when you might face problem with Orchestra Platform where an extension might cause a bug and your application stop working. In such event, you can use the safe mode to stop any extension from being loaded during bootstrap. To do this, just set `EXTENSION_MODE=safe` to your `.env`. This way, we would create a session data to indicate that you are browsing the site in safe mode. Once you have deactivate any problematic/broken extension just remove the value or change it to `EXTENSION_MODE=normal` to browse the website normally (with extensions re-enabled). [block:code] { "codes": [ { "code": "EXTENSION_MODE=safe", "language": "text", "name": ".env" } ] } [/block] [block:callout] { "type": "info", "body": "You can also use `?_mode=safe` (default to `normal`) as URL query string.", "title": "Disable Extension using the URL" } [/block]