Silverstripe

https://docs.silverstripe.org/en/4/
Admin
Silverstripe is an open-source content management system (CMS) and framework for building websites...
Tokens:106,617
Snippets:807
Trust Score:9.7
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install and use Node.js with nvm

Source: https://docs.silverstripe.org/en/4/contributing/build_tooling

Use nvm to install and switch to the required Node.js version before running build commands.

```bash
nvm install && nvm use
```

--------------------------------

### Lint documentation locally

Source: https://docs.silverstripe.org/en/4/contributing/documentation

Commands to install dependencies and run the documentation linter from the command line.

```bash
yarn install
composer install
yarn lint
```

--------------------------------

### Example Project Folder Structure

Source: https://docs.silverstripe.org/en/4/getting_started/server_requirements

The recommended directory structure when moving the .protected/ folder outside of the public webroot.

```text
.protected/
  <hash>/my-protected-file.txt
public/
  index.php
  assets/
    my-public-file.txt
vendor/
app/
```

--------------------------------

### Install Silverstripe CMS via Composer

Source: https://docs.silverstripe.org/en/4/getting_started

Run this command to create a new project using the Silverstripe installer.

```bash
composer create-project silverstripe/installer my-project
```

--------------------------------

### Install Sake wrapper

Source: https://docs.silverstripe.org/en/4/developer_guides/cli

Copy the sake executable to a system directory for easier access on UNIX-like systems.

```bash
cd your-webroot/
sudo ./vendor/bin/sake installsake
```

--------------------------------

### Verify Composer installation

Source: https://docs.silverstripe.org/en/4/getting_started/composer

Run this command to ensure the composer command is installed globally and accessible.

```bash
composer help
```

--------------------------------

### Install yarn globally

Source: https://docs.silverstripe.org/en/4/contributing/build_tooling

Install the yarn package manager globally using npm.

```bash
npm install -g yarn
```

--------------------------------

### Install module dependencies

Source: https://docs.silverstripe.org/en/4/contributing/build_tooling

Run yarn install in the silverstripe/admin directory and any module directory you are working on.

```bash
yarn install
```

--------------------------------

### Check for recipe-core installation

Source: https://docs.silverstripe.org/en/4/changelogs/4.6.0

Run this command from your project root to determine if your project uses silverstripe/recipe-core.

```bash
composer show silverstripe/recipe-core
```

--------------------------------

### Install module via Composer

Source: https://docs.silverstripe.org/en/4/getting_started/composer

Install the module using the standard composer require command; Composer will automatically prioritize the repositories defined in your configuration.

```bash
composer require silverstripe/cms
```

--------------------------------

### Install a module with a specific version constraint

Source: https://docs.silverstripe.org/en/4/getting_started/composer

Installs a specific version of a module by appending a version constraint to the package name.

```bash
composer require silverstripe/blog ^2
```

--------------------------------

### Install dependencies for production deployment

Source: https://docs.silverstripe.org/en/4/getting_started/composer

Uses composer install to deploy dependencies from the lock file, excluding development packages and optimizing the autoloader.

```bash
composer install --no-dev -o
```

--------------------------------

### Install Silverstripe CMS project via Composer

Source: https://docs.silverstripe.org/en/4/contributing/code

Use this command to create a new project installation for a specific branch, such as 4.13.x-dev.

```bash
composer create-project --keep-vcs silverstripe/installer ./your-website-folder 4.13.x-dev
```

--------------------------------

### Schedule tasks with cron

Source: https://docs.silverstripe.org/en/4/developer_guides/cli

Example of a cron job configuration to run a BuildTask every minute using sake.

```bash
* * * * * /your/site/folder/vendor/bin/sake dev/tasks/MyTask
```

--------------------------------

### Install ErrorPage Module

Source: https://docs.silverstripe.org/en/4/changelogs/4.0.0

Use Composer to install the silverstripe/errorpage module to restore ErrorPage functionality.

```bash
composer require silverstripe/errorpage
```

--------------------------------

### Schedule migration subtask as queued job via browser

Source: https://docs.silverstripe.org/en/4/changelogs/4.4.6

Example URL for scheduling the migration task as a queued job.

```text
https://example.com/dev/tasks/queue/MigrateFileTask?only=migrate-folders
```

--------------------------------

### Define ownership with database relationships

Source: https://docs.silverstripe.org/en/4/changelogs/4.0.0

Example showing a ProductPage owning a list of Products via a has_many relationship.

```php
namespace App\PageType;

use App\Model\Product;
use Page;

class ProductPage extends Page
{
    private static $has_many = [
        'Products' => Product::class,
    ];

    private static $owns = [
        'Products',
    ];
}
```

```php
namespace App\Model;

use App\PageType\ProductPage;
use SilverStripe\ORM\DataObject;
use SilverStripe\Versioned\Versioned;

class Product extends DataObject
{
    private static $extensions = [
        Versioned::class,
    ];

    private static $has_one = [
        'Parent' => ProductPage::class,
    ];
}
```

--------------------------------

### Retrieve a module via ModuleLoader

Source: https://docs.silverstripe.org/en/4/changelogs/4.0.0

Example of using the new ModuleLoader manifest to find modules by their composer name.

```php
$cms = ModuleLoader::inst()->getManifest()->getModule('silverstripe/cms')
```

--------------------------------

### Update module paths to vendor directory

Source: https://docs.silverstripe.org/en/4/changelogs/4.0.0

Modules are now installed in the vendor directory. Update your project structure to reflect the new paths.

```diff
-framework/
+vendor/silverstripe/framework/
-cms/
+vendor/silverstripe/cms/
...
```

--------------------------------

### Define Image Relationships in DataObjects

Source: https://docs.silverstripe.org/en/4/changelogs/4.0.0

Example of using the Image class or DBFile with the 'image/supported' category to restrict asset assignments to valid image types.

```php
namespace App";

use SilverStripe\Assets\Image;
use SilverStripe\ORM\DataObject;

class MyObject extends DataObject
{
    private static $has_one = [
        'ImageObject' => Image::class,
    ];
    private static $db = [
        'ImageField' => "DBFile('image/supported')",
    ];
}
```

--------------------------------

### Example of a well-formatted commit message

Source: https://docs.silverstripe.org/en/4/contributing/code

A commit message should start with a prefix followed by a short summary, with additional details provided in the body.

```text
FIX Allow multiple iterations of eager-loaded DataLists

Previously, a second iteration would add every relation item to the
relation list a second time - so with each iteration your relation list
count doubled (though it was the same records time and again).
```

--------------------------------

### Configure .env environment variables

Source: https://docs.silverstripe.org/en/4/getting_started

Create a .env file in your project root to define database and administrative credentials. Replace the placeholders with your specific environment details.

```bash
SS_DATABASE_CLASS="MySQLDatabase"
SS_DATABASE_NAME="<database>"
SS_DATABASE_SERVER="localhost"
SS_DATABASE_USERNAME="<user>"
SS_DATABASE_PASSWORD="<password>"
SS_DEFAULT_ADMIN_USERNAME="admin"
SS_DEFAULT_ADMIN_PASSWORD="password"
SS_ENVIRONMENT_TYPE="<dev|test|live>"
```

--------------------------------

### Install a module with composer require

Source: https://docs.silverstripe.org/en/4/getting_started/composer

Installs the latest compatible version of a specified Silverstripe module.

```bash
composer require silverstripe/blog
```

--------------------------------

### Create project from 4.0.x-dev

Source: https://docs.silverstripe.org/en/4/getting_started/composer

Initializes a new project using the latest development version within the 4.0.x series.

```bash
composer create-project silverstripe/installer ./my-project 4.0.x-dev
```

--------------------------------

### Build the database

Source: https://docs.silverstripe.org/en/4/getting_started

Execute this command to build the database after configuring your environment variables.

```bash
vendor/bin/sake dev/build
```

--------------------------------

### Check for silverstripe/mimevalidator installation

Source: https://docs.silverstripe.org/en/4/changelogs/4.4.7

Run this command from your project root to verify if the mimevalidator module is currently installed.

```bash
composer show silverstripe/mimevalidator
```

--------------------------------

### Create project from dev-master

Source: https://docs.silverstripe.org/en/4/getting_started/composer

Initializes a new project using the latest unstable version of the silverstripe/installer.

```bash
composer create-project silverstripe/installer ./my-project dev-master
```
Tokens:
Raw