PHPackages                             vardot/platformsh-varbase - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. vardot/platformsh-varbase

ActiveProject[Utility & Helpers](/categories/utility)

vardot/platformsh-varbase
=========================

Project template for Varbase distribution.

10JavaScript

Since May 21Pushed 3d ago1 watchersCompare

[ Source](https://github.com/Vardot/platformsh-varbase)[ Packagist](https://packagist.org/packages/vardot/platformsh-varbase)[ RSS](/packages/vardot-platformsh-varbase/feed)WikiDiscussions master Synced today

READMEChangelogDependenciesVersions (1)Used By (0)

Varbase Project Template for Upsun
==================================

[](#varbase-project-template-for-upsun)

This project provides a starter kit for Varbase 11.0.x projects hosted on [Upsun](https://upsun.com). It is very closely based on the [Varbase Composer project](https://github.com/Vardot/varbase-project).

This template builds Varbase ~11.0.0 using the Varbase Composer project template. It also includes configuration to use Redis for caching, although that must be enabled post-install in `.upsun/config.yaml`.

Drupal is a flexible and extensible PHP-based CMS framework.

Quick start
-----------

[](#quick-start)

```
git clone https://github.com/Vardot/platformsh-varbase myproject
cd myproject
upsun project:create
upsun push
```

The default app is configured under `.upsun/` so no extra flags are needed.

Services
--------

[](#services)

- PHP 8.4
- MariaDB 10.11
- Redis 6
- Drush included
- Automatic TLS certificates
- Composer-based build

Deploying to Upsun
------------------

[](#deploying-to-upsun)

1. Create a free trial:

    [Register for a free trial with Upsun](https://auth.upsun.com/register). When you have completed signup, select the **Create from scratch** project option. Give your project a name, and select a region where you would like it to be deployed. For the *Production environment* option, make sure to match it to this repository's settings, or to what you have updated the default branch to locally.
2. Install the Upsun CLI

    #### Linux/OSX

    [](#linuxosx)

    ```
    curl -fsS https://upsun.com/cli/installer | php
    ```

    #### Windows

    [](#windows)

    ```
    curl -f https://upsun.com/cli/installer -o cli-installer.php
    php cli-installer.php
    ```

    You can verify the installation by logging in (`upsun login`) and listing your projects (`upsun project:list`).
3. Set the project remote

    Find your `PROJECT_ID` by running the command `upsun project:list`

    ```
    +---------------+------------------------------------+------------------+---------------------------------+
    | ID            | Title                              | Region           | Organization                    |
    +---------------+------------------------------------+------------------+---------------------------------+
    | PROJECT_ID    | Your Project Name                  | xx-5.upsun.com   | your-username                   |
    +---------------+------------------------------------+------------------+---------------------------------+
    ```

    Then from within your local copy, run the command `upsun project:set-remote PROJECT_ID`.
4. Push

    ```
    upsun push
    ```

    or

    ```
    git push upsun DEFAULT_BRANCH
    ```

Integrate with a GitHub repo and deploy pull requestsConsult the [GitHub integration documentation](https://docs.upsun.com/integrations/source/github.html) to finish connecting your repository to a project on Upsun. You will need to create an access token on GitHub to do so.

Integrate with a GitLab repo and deploy merge requestsConsult the [GitLab integration documentation](https://docs.upsun.com/integrations/source/gitlab.html) to finish connecting a repository to a project on Upsun. You will need to create an access token on GitLab to do so.

Integrate with a Bitbucket repo and deploy pull requestsConsult the [Bitbucket integration documentation](https://docs.upsun.com/integrations/source/bitbucket.html) to finish connecting a repository to a project on Upsun. You will need to create an access token on Bitbucket to do so.

### Post-install

[](#post-install)

Run through the Drupal installer as normal. You will not be asked for database credentials as those are already provided.

### Local development

[](#local-development)

This section provides instructions for running the template locally, connected to a live database instance on an active Upsun environment.

In all cases for developing with Upsun, it's important to develop on an isolated environment - do not connect to data on your production environment when developing locally. Each of the options below assumes that you have already deployed this template to Upsun, as well as the following starting commands:

```
$ upsun get PROJECT_ID
$ cd project-name
$ upsun environment:branch updates
```

Drupal: using ddev
ddev makes it simple to develop Drupal locally. In general, the steps are as follows:

1. [Install ddev](https://ddev.readthedocs.io/en/stable/#installation).
2. [Retrieve an API token](https://docs.upsun.com/administration/cli/api-tokens.html) for your organization via the management console.
3. Update your ddev global configuration file to use the token you've just retrieved: ```
    web_environment:
    - UPSUN_CLI_TOKEN=abcdeyourtoken
    ```
4. Run `ddev restart`.
5. Get your project ID with `upsun project:info`. If you have not already connected your local repo with the project, you can run `upsun project:list` to locate the project ID, and `upsun project:set-remote PROJECT_ID` to configure Upsun locally.
6. Get the current environment's data with `ddev pull upsun`.
7. When you have finished with your work, run `ddev stop` and `ddev poweroff`.

Drupal: using Lando
Lando supports PHP applications configured to run on Upsun.

1. [Install Lando](https://docs.lando.dev/getting-started/installation.html).
2. Make sure Docker is already running - Lando will attempt to start Docker for you, but it's best to have it running in the background before beginning.
3. Start your apps and services with the command `lando start`.
4. To get up-to-date data from your Upsun environment, run the command `lando pull`.
5. If at any time you have updated your Upsun configuration files, run the command `lando rebuild`.
6. When you have finished with your work, run `lando stop` and `lando poweroff`.

> **Note:**
>
> For many of the steps above, you may need to include the CLI flags `-p PROJECT_ID` and `-e ENVIRONMENT_ID` if you are not in the project directory or if the environment is associated with an existing pull request.

Configuration files
-------------------

[](#configuration-files)

FilePurpose[`config/sync/.gitkeep`](config/sync/.gitkeep)Drupal configuration sync directory[`web/sites/default/settings.php`](web/sites/default/settings.php)Drupal settings, imports `settings.platformsh.php` for Upsun integration[`web/sites/default/settings.platformsh.php`](web/sites/default/settings.platformsh.php)Upsun-specific configuration: database connection to MariaDB and Redis caching[`.environment`](.environment)Environment variables sourced before start, deploy, post\_deploy hooks, and SSH sessions[`.upsun/config.yaml`](.upsun/config.yaml)**Primary Upsun configuration** — defines applications, services, routes, and the build/deploy process[`drush/platformsh_generate_drush_yml.php`](drush/platformsh_generate_drush_yml.php)Generates Drush YAML configuration on every deployment[`php.ini`](php.ini)PHP settings tuned for production, based on [Blackfire.io](https://blackfire.io) best practices[`.blackfire.yml`](.blackfire.yml)Starter [Blackfire.io](https://blackfire.io) configuration[`.lando.upstream.yml`](.lando.upstream.yml)[Lando](https://docs.lando.dev/) local development configuration[`.ddev/config.yaml`](.ddev/config.yaml)[ddev](https://ddev.readthedocs.io/) local development configurationMigrating your data
-------------------

[](#migrating-your-data)

If you are moving an existing site to Upsun, then in addition to code you also need to migrate your data.

Importing the database
Obtain a database dump from your current site and save it as `database.sql`. Then import the database into your Upsun site using the CLI:

```
upsun sql -e main