https://github.com/docksal/boilerplate-drupal10-composer
https://github.com/docksal/boilerplate-drupal10-composer
Last synced: over 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/docksal/boilerplate-drupal10-composer
- Owner: docksal
- Created: 2022-12-16T17:17:52.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-12-16T17:18:34.000Z (over 3 years ago)
- Last Synced: 2024-04-13T21:54:56.966Z (about 2 years ago)
- Language: PHP
- Size: 37.1 KB
- Stars: 3
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Docksal powered Drupal 10 With Composer Installation
This is a sample Drupal 10 with Composer installation pre-configured for use with Docksal.
Features:
- Drupal 10 Composer Project
- `fin init` [example](.docksal/commands/init)
- Using the [default](.docksal/docksal.env#L9) Docksal LAMP stack with [image version pinning](.docksal/docksal.env#L13-L15)
- PHP and MySQL settings overrides [examples](.docksal/etc)
## Setup instructions
### Step #1: Docksal environment setup
**This is a one time setup - skip this if you already have a working Docksal environment.**
Follow [Docksal environment setup instructions](https://docs.docksal.io/getting-started/setup/)
### Step #2: Project setup
1. Clone this repo into your Projects directory
```
git clone https://github.com/docksal/boilerplate-drupal10-composer.git drupal10
cd drupal10
```
2. Initialize the site
This will initialize local settings and install the site via drush
```
fin init
```
A `composer.lock` file will be generated. This file should be committed to your repository.
3. Point your browser to
```
http://drupal10.docksal.site
```
When the automated install is complete, the command line output will display the admin username and password.
## More automation with 'fin init'
Site provisioning can be automated using `fin init`, which calls the shell script in [.docksal/commands/init](.docksal/commands/init).
This script is meant to be modified per project. The one in this repo will give you a good starting example.
Some common tasks that can be handled by the init script (and other [custom commands](https://docs.docksal.io/fin/custom-commands/)):
- initialize local settings files for Docker Compose, Drupal, Behat, etc.
- import DB or perform a site install
- compile Sass
- run DB updates, revert features, clear caches, etc.
- enable/disable modules, update variables values
## Security notice
This repo is intended for quick start demos and includes a hardcoded value for `hash_salt` in `settings.php`.
If you are basing your project code base on this repo, make sure you regenerate and update the `hash_salt` value.
A new value can be generated with `drush ev '$hash = Drupal\Component\Utility\Crypt::randomBytesBase64(55); print $hash . "\n";'`