Silverstripe CMS

https://docs.silverstripe.org/en/5
Admin
Silverstripe CMS is an open-source content management system and framework for building websites and...
Tokens:58,230
Snippets:671
Trust Score:9.7
Update:3 days ago
Show doc for...
Tokens:
Raw
### Run composer install

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

Run this command to install dependencies from the composer.lock file.

```bash
composer install
```

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

### Install and use Node.js with nvm

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

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

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

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

### Verify Composer installation

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

Run this command to verify that Composer is installed and accessible globally.

```bash
composer help
```

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

### Internal filesystem structure example

Source: https://docs.silverstripe.org/en/5/developer_guides/files/file_security

An example of how files are organized within the assets directory, showing the distinction between public and protected storage.

```text
assets/
    OldCompanyLogo.gif
    .protected/
        .htaccess
        a870de278b/
            NewCompanyLogo.gif
```

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

### Lint documentation locally

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

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

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

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

### Install module via Composer

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

Use the standard composer require command to install the module. Composer will prioritize the repository defined in your configuration.

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

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

### Install module for development

Source: https://docs.silverstripe.org/en/5/developer_guides/extending/modules

Command to install a module from a specific branch using the --prefer-source flag to maintain the git repository.

```bash
composer require my_vendor/module_name:dev-main --prefer-source
```

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

### Install yarn globally

Source: https://docs.silverstripe.org/en/5/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/5/contributing/build_tooling

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

```bash
yarn install
```

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

### Install sake utility

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

Copies the sake utility to the system path for easier access on UNIX-like systems.

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

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

### Install a module via Composer

Source: https://docs.silverstripe.org/en/5/developer_guides/extending/modules

Use the composer require command in the project root to install a module, such as the blog module, using its unique identifier.

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

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

### Install Silverstripe Project via Composer

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

Use this command to create a new Silverstripe project from the installer, targeting a specific development branch.

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

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

### Create project with latest unstable installer

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

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

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

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

### Install a module with a specific version constraint

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

Installs a module while specifying a version constraint, such as ^2, after the package name.

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

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

### Create a project with version constraints

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

Use this command to install a specific version of Silverstripe CMS by providing a version constraint.

```bash
composer create-project silverstripe/installer ./my-project ^4.13
```

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

### Configure composer.json for a new module

Source: https://docs.silverstripe.org/en/5/developer_guides/extending/modules

Example configuration for a module's composer.json file, including dependencies on Silverstripe framework, CMS, and the blog module.

```json
{
    "name": "my_vendor/module_name",
    "description": "Short module description",
    "type": "silverstripe-vendormodule",
    "require": {
        "silverstripe/framework": "^5.0",
        "silverstripe/cms": "^5.0",
        "silverstripe/blog": "^5.0"
    }
}
```

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

### Create a new Silverstripe project

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

Use this command to create a new Silverstripe CMS project in the specified directory using the default installer.

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

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

### Configure Custom Sendmail Binary

Source: https://docs.silverstripe.org/en/5/developer_guides/email

Example DSN string for specifying a custom path to a sendmail binary.

```bash
# .env
MAILER_DSN="sendmail://default?command=/path/to/mysendmailbinary%20-t"
```

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

### Manage daemon processes with sake

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

Starts or stops a daemon process controller using the sake command.

```bash
sake -start my_process
sake -stop my_process
```

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

### Example Protected Assets Folder Structure

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

Visual representation of the recommended folder structure when the .protected/ folder is moved outside the public/ directory.

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

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

### Run composer install for production

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

Use this command on your production version. The --no-dev flag excludes development dependencies, and -o optimizes the autoloader.

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

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

### Build the database

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

Run this command to initialize or update the database schema after configuration.

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

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

### Create a Silverstripe project for development

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

Initializes a new project with full git history and development versions using the --keep-vcs and --prefer-source flags.

```bash
composer create-project --keep-vcs silverstripe/installer ./my-project 5.x-dev --prefer-source
```

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

### Create project with specific development minor release

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

Initializes a new project using the latest development version within the 5.0.x minor release.

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

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

### Configure .env environment variables

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

Define your database credentials and environment type in the .env file located in the project root.

```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>"
```

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

### Define German JavaScript dictionary

Source: https://docs.silverstripe.org/en/5/developer_guides/i18n

Example of a translation table for German in <my-module-dir>/javascript/lang/de.js.

```javascript
ss.i18n.addDictionary('de', {
  'MYMODULE.MYENTITY': 'Artikel wirklich löschen?'
});
```

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

### Define English JavaScript dictionary

Source: https://docs.silverstripe.org/en/5/developer_guides/i18n

Example of a distribution table for English in <my-module-dir>/javascript/lang/en.js.

```javascript
if (typeof (ss) === 'undefined' || typeof (ss.i18n) === 'undefined') {
  /* eslint-disable-next-line no-console */
  console.error('Class ss.i18n not defined');
} else {
  ss.i18n.addDictionary('en', {
    'MYMODULE.MYENTITY': 'Really delete these articles?'
  });
}
```

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

### Define DBFile in DataObject

Source: https://docs.silverstripe.org/en/5/developer_guides/files/file_storage

Example of defining a DBFile field within a SilverStripe DataObject.

```php
namespace App\Model;

use SilverStripe\ORM\DataObject;

class Banner extends DataObject
{
    private static $db = [
        'Image' => 'DBFile',
    ];
}
```

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

### Configure SMTP Transport

Source: https://docs.silverstripe.org/en/5/developer_guides/email

Example DSN string for configuring an SMTP server with authentication.

```bash
# .env
MAILER_DSN="smtp://user:pass@smtp.example.com:1234"
```

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

### Configure Webpack externals

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

Example webpack.config.js configuration to exclude shared dependencies from your bundle.

```javascript
module.exports = {
  entry: {
    bundle: 'mymodule/client/src/js/bundle.js',
  },
  output: {
    path: './client/dist',
    filename: 'js/[name].js',
  },
  externals: {
    'components/FormBuilder/FormBuilder': 'FormBuilder',
    jQuery: 'jQuery',
    react: 'react',
  }
};
```

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

### Hint box syntax

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

Use the TIP callout block to highlight extra use cases or helpful hints.

```markdown
> [!TIP]
> ...
```

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

### Define German language table

Source: https://docs.silverstripe.org/en/5/developer_guides/i18n

Example of a YAML language table for German stored in framework/lang/de.yml.

```yaml
de:
  ImageUploader:
    ATTACH: '{title} anhängen'
  UploadField:
    NOTEADDFILES: 'Sie können Dateien hinzufügen sobald Sie das erste mal gespeichert haben'
```

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

### Define English language table

Source: https://docs.silverstripe.org/en/5/developer_guides/i18n

Example of a YAML language table for English stored in framework/lang/en.yml.

```yaml
en:
  ImageUploader:
    Attach: 'Attach {title}'
  UploadField:
    NOTEADDFILES: 'You can add files once you have saved for the first time.'
```

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

### Inspect PHP configuration

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

Use the phpinfo function to verify your current PHP environment settings.

```php
phpinfo()
```

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

### Schema Introspection JSON Structure

Source: https://docs.silverstripe.org/en/5/developer_guides/graphql/tips_and_tricks

Example of the JSON structure generated by the SchemaTranscriber for client-side introspection.

```json
{
   "data":{
      "__schema":{
         "types":[
            {
               "kind":"OBJECT",
               "name":"Query",
               "possibleTypes":null
            }
            // etc ...
         ]
      }
   }
}
```

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

### Suppress Email Sending

Source: https://docs.silverstripe.org/en/5/developer_guides/email

Example DSN string to disable email sending, useful for development environments.

```bash
# .env
MAILER_DSN="null://default"
```

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

### Execute controllers and build tasks with sake

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

Runs specific controllers or development operations using the sake wrapper.

```bash
sake /
# returns the homepage

sake dev/
# shows a list of development operations
```

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

### Deprecating a class with Deprecation::withSuppressedNotice

Source: https://docs.silverstripe.org/en/5/developer_guides/deprecations

Example of a deprecated class using the @deprecated docblock and wrapping the notice in Deprecation::withSuppressedNotice within the constructor.

```php
namespace App;

/**
 * @deprecated 4.12.0 Will be removed without equivalent functionality in a future major release
 */
class MyDeprecatedClass extends AnotherClass
{
    public function __construct()
    {
        Deprecation::withSuppressedNotice(function () {
            Deprecation::notice(
                '4.12.0',
                'Will be removed without equivalent functionality in a future major release',
                Deprecation::SCOPE_CLASS
            );
        });
        parent::__construct();
    }
}
```

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

### Reinstall Module with Source Code

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

Use this command to ensure you have the full source of a module for development, replacing <org>/<module> with the specific module name.

```bash
# re-install the module using prefer-source.
# replace <org>/<module> with the module you're making changes to (e.g. silverstripe/framework)
composer reinstall <org>/<module> --prefer-source
```
Tokens:
Raw