silverstripe-framework/docs/en/00_Getting_Started/index.md

54 lines
2.2 KiB
Markdown
Raw Normal View History

title: Getting Started
introduction: SilverStripe is a web application. This means that you will need to have a webserver and database. We will take you through the setup of the server environment as well the application itself.
## Server Requirements
SilverStripe requires PHP 7.1 or newer.
It runs on many webservers and databases,
but feels most at home running on Apache with MySQL/MariaDB.
If you are setting up your own environment,
you'll need to consider a few configuration settings
such as URL rewriting and protecting access to certain files.
Refer to our [server requirements](server_requirements) for details.
2012-11-03 06:00:58 +01:00
## Quickstart Installation
2012-11-03 06:00:58 +01:00
If you're running Apache with MySQL/MariaDB already,
and know your way around webservers, follow these steps to get started.
SilverStripe is installed via [composer](composer), a package management tool for PHP that
lets you install and upgrade the framework and other modules.
Assuming you've got this tool, run the following command to install SilverStripe:
2012-11-03 06:00:58 +01:00
```
composer create-project silverstripe/installer my-project
```
2012-11-03 06:00:58 +01:00
Within the newly created `my-project` folder, point your webserver at the `public/` folder.
Rename `.env.example` to `.env` in your project, and configure your database connection there.
See [environment variables](environment_management) for available configuration options,
e.g. to configure a default CMS login via `SS_DEFAULT_ADMIN_USERNAME`.
2012-11-03 06:00:58 +01:00
Now you should be able to build your database by running this command:
```
vendor/bin/sake dev/build
```
Your website should be available on your domain now (e.g. `http://localhost`).
The CMS login can be accessed at `/admin`.
2012-11-03 06:00:58 +01:00
## Guided Installation
2012-11-03 06:00:58 +01:00
If you are unsure on how this all works, or prefer to follow
an installer wizard, please jump on our [lessons](https://www.silverstripe.org/learn/lessons/v4/).
Webserver setup is covered in
[Lesson 4: Setting up a local dev environment](https://www.silverstripe.org/learn/lessons/v4/up-and-running-setting-up-a-local-silverstripe-dev-environment-1)
2012-11-03 06:00:58 +01:00
## Troubleshooting
If you run into trouble, see [common-problems](common_problems) or
2017-12-18 23:45:16 +01:00
check our [community help options](https://www.silverstripe.org/community/).