{"id":13852401,"url":"https://github.com/phase2/octane","last_synced_at":"2025-09-03T02:20:30.389Z","repository":{"id":57038621,"uuid":"61045162","full_name":"phase2/octane","owner":"phase2","description":"Drupal 8 starting distro","archived":false,"fork":false,"pushed_at":"2019-02-04T18:25:22.000Z","size":340,"stargazers_count":20,"open_issues_count":0,"forks_count":10,"subscribers_count":55,"default_branch":"8.x-4.x","last_synced_at":"2025-05-15T18:51:40.414Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/phase2.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-06-13T14:56:43.000Z","updated_at":"2022-06-17T18:46:17.000Z","dependencies_parsed_at":"2022-08-23T21:00:31.879Z","dependency_job_id":null,"html_url":"https://github.com/phase2/octane","commit_stats":null,"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"purl":"pkg:github/phase2/octane","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phase2%2Foctane","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phase2%2Foctane/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phase2%2Foctane/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phase2%2Foctane/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/phase2","download_url":"https://codeload.github.com/phase2/octane/tar.gz/refs/heads/8.x-4.x","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phase2%2Foctane/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273377741,"owners_count":25094640,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-03T02:00:09.631Z","response_time":76,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-04T22:01:18.735Z","updated_at":"2025-09-03T02:20:30.366Z","avatar_url":"https://github.com/phase2.png","language":"PHP","funding_links":[],"categories":["PHP"],"sub_categories":[],"readme":"# Octane\nThis is a composer project used to spin up a starting instance of Drupal 8 Octane.\nOctane is a Drupal 8 project scaffold that provides the following features:\n* Uses the Acquia/Lightning distribution.\n* Uses Particle for the Pattern-Lab based theme.\n* Adds common modules needed by most large Drupal 8 sites.\n* Provides starting configuration for Docksal.\n* Provides starting configuration for Outrigger.\n* (TODO) Provides starting configuration for CI on GitLabs.\n\n## Installation\nTo create a Drupal Octane project clone this repository to a directory\nnamed for your project.\n\nScripts for managing your site are located in the ``bin`` folder:\n* **Native** (no docker containers) - run scripts in ``./bin`` directly.\n* **Docksal** - run a script via ``fin scriptname``.\n* **Outrigger** - run a script via ``rig project scriptname``.\n\nTo initialize your Drupal project, run the ``init`` script. \nIt takes an optional argument to specify which \"profile\" to install.\nBy default the \"Lightning\" profile will be used. Other options are\n\"standard\" or \"minimal\".\n\nThis will create the docker containers, create a database, and install Drupal.\nYour site will be available at ``projectname.docksal`` for Docksal or\n``projectname.vm`` for Outrigger.\n\nDocksal example:\n```\nfin init\n```\nOutrigger example:\n```\nrig project init\n\n```\n\nIf configuration files are detected in the ``src/config/default`` directory,\nthe site will be installed using this existing config and the profile argument\nwill be ignored.\n\n## Custom Project Scripts\nCustom scripts for your project should be created in the ``/bin`` folder and\nthen referenced from either Outrigger or Docksal.\n\nFor Docksal, create a file within ``.docksal/commands`` that performs any\nspecific Docksal setup and then calls the script in ``/bin``.  See the ``init``\ncommand for an example.\n\nFor Outrigger, edit the ``.outrigger.yml`` file and add a custom script with any\nspecific Outrigger setup and then call the script in ``/bin``. See the\n``rig project init`` script for an example.\n\nThis will create the docker containers, create a database, and install Drupal.\n\n### Common Commands\n\nEach of these commands are available as either a ``fin COMMAND`` or \n``rig project COMMAND``.\n\n* ``rebuild`` - Used after a git-pull to run composer, run update hooks, import config, compile theme, clear cache.\n* ``theme`` - Used to compile the theme and then run browserstack to watch for sass, js, twig changes.\n\n## Docker Containers\nOutrigger uses the full ``docker-composer.yml`` (and ``docker-compose.override.yml`` locally)\nto define the docker containers, whereas Docksal defines a default stack and\nallows you to override the configuration in ``.docksal/docksal.yml`` which uses\nthe same docker-compose syntax but only needs to contain the local overrides.\n\nDefault environment variables for Outrigger are defined in the ``.env`` file\nwhile Docksal uses the ``.docksal/docksal.env`` file.\n\nThe following containers will be created and used for your site:\n\n* ``web`` - The Apache web container.\n* ``db`` - The MySQL (Docksal) or MariaDB (Outrigger) database container.\nDefault user is ``admin`` and pass ``admin`` can be changed in the environment\nvariables or db container configuration.\n\n### Build/CLI Container\nOne of the main priciples of Octane is to minimize the number of tools installed\non your local computer (only Composer) and instead perform most tasks within a \ndocker \"build\" container that contains all the tools.\n\nIn Outrigger, this Build container is defined in the ``build.yml`` docker-compose\nfile. Various application specific containers are build on the \"base\" container\nfor ``drush``, ``composer``, and generic ``cli`` commands. To run a script\nwithin the build container, use the command syntax:\n```$xslt\ndocker-compose -f build.yml run --rm cli /var/www/bin/SCRIPTNAME.sh\n```\nTypically you will create a ``rig project SCRIPTNAME`` alias for this in the \n``.outrigger.yml`` file or create a local alias in your own ``.bashrc`` file.\nFor example:\n```$xslt\nddrush='docker-compose -f build.yml run --rm drush'\n```\nfor running drush within the build container.\n\nTo open a bash shell into the Outrigger Build container, use\n```$xslt\nrig project bash\n```\n\nIn DockSal, the Build container is called ``cli`` and is defined within the\ndefault services stack, much like ``web`` or ``db`` and can be overridden\nusing the ``docksal.yml`` file.  Docksal provides its own set of aliases for\ncommon applications such as ``fin drush``, ``fin composer``, etc.  To\nrun a script within the build container, use the command syntax:\n```$xslt\nfin exec /var/www/bin/SCRIPTNAME.sh\n```\n\nTo open a bash shell into the Docksal Build/CLI container, use\n```$xslt\nfin bash\n```\n\nWhen creating a custom command for Docksal in the ``.docksal/commands``\ndirectory, you can add the comment\n```$xslt\n#: exec_target = cli\n```\nto the top of your script command file to cause it to be executed within the\nBuild/CLI container instead of running locally.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fphase2%2Foctane","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fphase2%2Foctane","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fphase2%2Foctane/lists"}