From 307dfc64b479af8b9b0be346bebcb492bf00e596 Mon Sep 17 00:00:00 2001 From: Alejandro Celaya Date: Mon, 1 Aug 2016 21:13:17 +0200 Subject: [PATCH] Created installation steps doc --- data/docs/installation.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 data/docs/installation.md diff --git a/data/docs/installation.md b/data/docs/installation.md new file mode 100644 index 00000000..67e241fc --- /dev/null +++ b/data/docs/installation.md @@ -0,0 +1,19 @@ +### Installation steps + +- Define ENV vars in apache or nginx: + - SHORTENED_URL_SCHEMA: http|https + - SHORTENED_URL_HOSTNAME: Short domain + - SHORTCODE_CHARS: The char set used to generate short codes (defaults to **123456789bcdfghjkmnpqrstvwxyzBCDFGHJKLMNPQRSTVWXYZ**, but a new one can be generated with the `config:generate-charset` command) + - DB_USER: MySQL database user + - DB_PASSWORD: MySQL database password + - REST_USER: Username for REST authentication + - REST_PASSWORD: Password for REST authentication + - DB_NAME: MySQL database name (defaults to **shlink**) + - DEFAULT_LOCALE: Language in which web requests (browser and REST) will be returned if no `Accept-Language` header is sent (defaults to **en**) + - CLI_LOCALE: Language in which console command messages will be displayed (defaults to **en**) +- Create database (`vendor/bin/doctrine orm:schema-tool:create`) +- Add write permissions to `data` directory +- Create doctrine proxies (`vendor/bin/doctrine orm:generate-proxies`) +- Create symlink to bin/cli as `shlink` in /usr/local/bin (linux only. Optional) + +Supported languages: es and en