Shlink installer
A PHP command line tool used to install shlink.
Installation
Install this tool using composer.
composer install shlinkio/shlink-installer
Usage
This is the command line tool used by shlink to guide you through the installation process.
The tool expects the active directory to be a valid shlink instance.
There are two main ways to run this tool:
-
Using the built-in CLI entry point.
Run
vendor/bin/shlink-installerto print all available commands.Shlink installer Usage: command [options] [arguments] Options: -h, --help Display help for the given command. When no command is given display help for the list command -q, --quiet Do not output any message -V, --version Display this application version --ansi Force ANSI output --no-ansi Disable ANSI output -n, --no-interaction Do not ask any interactive question -v|vv|vvv, --verbose Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug Available commands: help Displays help for a command install Guides you through the installation process, to get Shlink up and running. list Lists commands set-option Allows you to set new values for any config option. update Helps you import Shlink's config from an older version to a new one.You can also run
vendor/bin/shlink-installorvendor/bin/shlink-update, which alias theinstallandupdatecommands respectively, but this is deprecated and will be removed in next major release. -
Using the
bin/run.phphelper script.This script returns three functions that can be used to run the install or update, or the whole shlink installer tool.
Just require it and invoke the appropriate function:
declare(strict_types=1); [$install, $update, $installer] = require 'vendor/shlinkio/shlink-installer/bin/run.php'; $install(); // To install $update(); // To update $installer(); // To run any supported commands
Customize options
Questions to ask the user
In order to retain backwards compatibility, it is possible to configure the installer to ask just a specific subset of questions.
Add a configuration file including a configuration like this:
declare(strict_types=1);
use Shlinkio\Shlink\Installer\Config\Option;
return [
'installer' => [
'enabled_options' => [
Option\Database\DatabaseDriverConfigOption::class,
Option\Database\DatabaseHostConfigOption::class,
Option\BasePathConfigOption::class,
Option\Redirect\Regular404RedirectConfigOption::class,
Option\UrlShortener\ShortDomainHostConfigOption::class,
Option\UrlShortener\ShortDomainSchemaConfigOption::class,
],
],
];
If
installer.enabled_optionsis not provided at all, all the config options will be asked.
Commands to run after installation
After the user has been asked for all the config, the installer will run a set of scripts which will create/update the database, download assets, etc.
It is possible to overwrite those commands via configuration too, using a syntax like this:
declare(strict_types=1);
return [
'installer' => [
'installation_commands' => [
'db_create_schema' => [
'command' => 'bin/shlink shlink:db:create',
],
'db_migrate' => [
'command' => 'bin/some-script some:command',
],
'orm_proxies' => [
'command' => '-v', // Just print PHP version
],
],
],
];
This example shows all the currently available commands. They are run in the order they have been set here.
Important: Take into consideration that all the commands must be PHP scripts, since the installer will prefix all of them with the php binary.
33 Nov 16, 2022
2k Jan 4, 2023
23 Nov 13, 2022
1.8k Dec 30, 2022
2 Oct 22, 2021
324 Dec 8, 2022
5 Oct 7, 2022
102 Dec 31, 2022
18 Nov 1, 2019
32 Dec 26, 2022
4 Sep 8, 2021
2 Nov 12, 2021
2 Dec 26, 2022
745 Dec 30, 2022
324 Dec 8, 2022