3 * @copyright Copyright (C) 2010-2022, the Friendica project
5 * @license GNU AGPL version 3 or any later version
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU Affero General Public License as
9 * published by the Free Software Foundation, either version 3 of the
10 * License, or (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU Affero General Public License for more details.
17 * You should have received a copy of the GNU Affero General Public License
18 * along with this program. If not, see <https://www.gnu.org/licenses/>.
22 namespace Friendica\Console;
24 use Asika\SimpleConsole\Console;
26 use Friendica\App\BaseURL;
27 use Friendica\Core\Config\Capability\IManageConfigValues;
28 use Friendica\Core\Config\ValueObject\Cache;
29 use Friendica\Core\Installer;
30 use Friendica\Core\Theme;
31 use Friendica\Database\Database;
32 use Friendica\Util\BasePath;
35 class AutomaticInstallation extends Console
39 /** @var \Friendica\Core\Config\ValueObject\Cache */
41 /** @var IManageConfigValues */
46 protected function getHelp()
49 Installation - Install Friendica automatically
51 bin/console autoinstall [-h|--help|-?] [-v] [-a] [-f]
54 Installs Friendica with data based on the local.config.php file or environment variables
57 Not checking .htaccess/URL-Rewrite during CLI installation.
60 -h|--help|-? Show help information
61 -v Show more debug information.
62 -a All setup checks are required (except .htaccess)
63 -f|--file <config> prepared config file (e.g. "config/local.config.php" itself) which will override every other config option - except the environment variables)
64 -s|--savedb Save the DB credentials to the file (if environment variables is used)
65 -H|--dbhost <host> The host of the mysql/mariadb database (env MYSQL_HOST)
66 -p|--dbport <port> The port of the mysql/mariadb database (env MYSQL_PORT)
67 -s|--dbsocket <socket> The socket of the mysql/mariadb database (env MYSQL_SOCKET)
68 -d|--dbdata <database> The name of the mysql/mariadb database (env MYSQL_DATABASE)
69 -u|--dbuser <username> The username of the mysql/mariadb database login (env MYSQL_USER or MYSQL_USERNAME)
70 -P|--dbpass <password> The password of the mysql/mariadb database login (env MYSQL_PASSWORD)
71 -U|--url <url> The full base URL of Friendica - f.e. 'https://friendica.local/sub' (env FRIENDICA_URL)
72 -B|--phppath <php_path> The path of the PHP binary (env FRIENDICA_PHP_PATH)
73 -b|--basepath <base_path> The basepath of Friendica (env FRIENDICA_BASE_PATH)
74 -t|--tz <timezone> The timezone of Friendica (env FRIENDICA_TZ)
75 -L|--lang <language> The language of Friendica (env FRIENDICA_LANG)
78 MYSQL_HOST The host of the mysql/mariadb database (mandatory if mysql and environment is used)
79 MYSQL_PORT The port of the mysql/mariadb database
80 MYSQL_SOCKET The socket of the mysql/mariadb database
81 MYSQL_USERNAME|MYSQL_USER The username of the mysql/mariadb database login (MYSQL_USERNAME is for mysql, MYSQL_USER for mariadb)
82 MYSQL_PASSWORD The password of the mysql/mariadb database login
83 MYSQL_DATABASE The name of the mysql/mariadb database
84 FRIENDICA_URL The full base URL of Friendica - f.e. 'https://friendica.local/sub'
85 FRIENDICA_PHP_PATH The path of the PHP binary - leave empty for auto detection
86 FRIENDICA_BASE_PATH The basepath of Friendica - leave empty for auto detection
87 FRIENDICA_ADMIN_MAIL The admin email address of Friendica (this email will be used for admin access)
88 FRIENDICA_TZ The timezone of Friendica
89 FRIENDICA_LANG The langauge of Friendica
92 bin/console autoinstall -f 'input.config.php
93 Installs Friendica with the prepared 'input.config.php' file
95 bin/console autoinstall --savedb
96 Installs Friendica with environment variables and saves them to the 'config/local.config.php' file
98 bin/console autoinstall -H localhost -p 3365 -u user -P passwort1234 -d friendica -U https://friendica.fqdn
99 Installs Friendica with a local mysql database with credentials
103 public function __construct(App\Mode $appMode, Cache $configCache, IManageConfigValues $config, Database $dba, array $argv = null)
105 parent::__construct($argv);
107 $this->appMode = $appMode;
108 $this->configCache = $configCache;
109 $this->config = $config;
113 protected function doExecute(): int
115 // Initialise the app
116 $this->out("Initializing setup...");
118 $installer = new Installer();
120 $configCache = $this->configCache;
121 $basePathConf = $configCache->get('system', 'basepath');
122 $basepath = new BasePath($basePathConf);
123 $installer->setUpCache($configCache, $basepath->getPath());
125 $this->out(" Complete!\n");
128 $this->out("Checking environment...");
130 $installer->resetChecks();
132 if (!$this->runBasicChecks($installer, $configCache)) {
133 $errorMessage = $this->extractErrors($installer->getChecks());
134 throw new RuntimeException($errorMessage);
137 $this->out(" Complete!\n");
139 // if a config file is set,
140 $config_file = $this->getOption(['f', 'file']);
142 if (!empty($config_file)) {
143 $this->out("Loading config file '$config_file'...");
144 if (!file_exists($config_file)) {
145 throw new RuntimeException("ERROR: Config file does not exist.");
148 //append config file to the config cache
149 $config = include($config_file);
150 if (!is_array($config)) {
151 throw new Exception('Error loading config file ' . $config_file);
153 $configCache->load($config, Cache::SOURCE_FILE);
155 // Creating config file
156 $this->out("Creating config file...");
158 $save_db = $this->getOption(['s', 'savedb'], false);
160 $db_host = $this->getOption(['H', 'dbhost'], ($save_db) ? (getenv('MYSQL_HOST')) : Installer::DEFAULT_HOST);
161 $db_port = $this->getOption(['p', 'dbport'], ($save_db) ? getenv('MYSQL_PORT') : null);
162 $db_socket = $this->getOption(['s', 'dbsocket'], ($save_db) ? getenv('MYSQL_SOCKET') : null);
163 $configCache->set('database', 'hostname', $db_host . (!empty($db_port) ? ':' . $db_port : ''));
164 $configCache->set('database', 'database',
165 $this->getOption(['d', 'dbdata'],
166 ($save_db) ? getenv('MYSQL_DATABASE') : ''));
167 $configCache->set('database', 'username',
168 $this->getOption(['u', 'dbuser'],
169 ($save_db) ? getenv('MYSQL_USER') . getenv('MYSQL_USERNAME') : ''));
170 $configCache->set('database', 'password',
171 $this->getOption(['P', 'dbpass'],
172 ($save_db) ? getenv('MYSQL_PASSWORD') : ''));
174 $php_path = $this->getOption(['b', 'phppath'], !empty('FRIENDICA_PHP_PATH') ? getenv('FRIENDICA_PHP_PATH') : null);
175 if (!empty($php_path)) {
176 $configCache->set('config', 'php_path', $php_path);
178 $configCache->set('config', 'php_path', $installer->getPHPPath());
181 $configCache->set('config', 'admin_email',
182 $this->getOption(['A', 'admin'],
183 !empty(getenv('FRIENDICA_ADMIN_MAIL')) ? getenv('FRIENDICA_ADMIN_MAIL') : ''));
184 $configCache->set('system', 'default_timezone',
185 $this->getOption(['T', 'tz'],
186 !empty(getenv('FRIENDICA_TZ')) ? getenv('FRIENDICA_TZ') : Installer::DEFAULT_TZ));
187 $configCache->set('system', 'language',
188 $this->getOption(['L', 'lang'],
189 !empty(getenv('FRIENDICA_LANG')) ? getenv('FRIENDICA_LANG') : Installer::DEFAULT_LANG));
191 $basepath = $this->getOption(['b', 'basepath'], !empty(getenv('FRIENDICA_BASE_PATH')) ? getenv('FRIENDICA_BASE_PATH') : null);
192 if (!empty($basepath)) {
193 $configCache->set('system', 'basepath', $basepath);
196 $url = $this->getOption(['U', 'url'], !empty(getenv('FRIENDICA_URL')) ? getenv('FRIENDICA_URL') : null);
199 $this->out('The Friendica URL has to be set during CLI installation.');
202 $baseUrl = new BaseURL($this->config, []);
203 $baseUrl->saveByURL($url);
206 $installer->createConfig($configCache);
209 $this->out(" Complete!\n");
211 // Check database connection
212 $this->out("Checking database...");
214 $installer->resetChecks();
216 if (!$installer->checkDB($this->dba)) {
217 $errorMessage = $this->extractErrors($installer->getChecks());
218 throw new RuntimeException($errorMessage);
221 $this->out(" Complete!\n");
224 $this->out("Inserting data into database...\n");
226 $installer->resetChecks();
228 if (!$installer->installDatabase()) {
229 $errorMessage = $this->extractErrors($installer->getChecks());
230 throw new RuntimeException($errorMessage);
233 if (!empty($config_file) && $config_file != 'config' . DIRECTORY_SEPARATOR . 'local.config.php') {
235 $this->out("Copying config file...");
236 if (!copy($config_file, $basePathConf . DIRECTORY_SEPARATOR . 'config' . DIRECTORY_SEPARATOR . 'local.config.php')) {
237 throw new RuntimeException("ERROR: Saving config file failed. Please copy '$config_file' to '" . $basePathConf . "'" . DIRECTORY_SEPARATOR . "config" . DIRECTORY_SEPARATOR . "local.config.php' manually.\n");
241 $this->out(" Complete!\n");
244 $this->out("Installing theme");
245 if (!empty($this->config->get('system', 'theme'))) {
246 Theme::install($this->config->get('system', 'theme'));
247 $this->out(" Complete\n");
249 $this->out(" Theme setting is empty. Please check the file 'config/local.config.php'\n");
252 $this->out("\nInstallation is finished");
258 * @param Installer $installer The Installer instance
259 * @param \Friendica\Core\Config\ValueObject\Cache $configCache The config cache
261 * @return bool true if checks were successfully, otherwise false
262 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
264 private function runBasicChecks(Installer $installer, Cache $configCache)
268 $installer->resetChecks();
269 if (!$installer->checkFunctions()) {
272 if (!$installer->checkImagick()) {
275 if (!$installer->checkLocalIni()) {
278 if (!$installer->checkSmarty3()) {
281 if (!$installer->checkKeys()) {
285 $php_path = $configCache->get('config', 'php_path');
287 if (!$installer->checkPHP($php_path, true)) {
291 $this->out(" NOTICE: Not checking .htaccess/URL-Rewrite during CLI installation.\n");
297 * @param array $results
301 private function extractErrors($results)
304 $allChecksRequired = $this->getOption('a') !== null;
306 foreach ($results as $result) {
307 if (($allChecksRequired || $result['required'] === true) && $result['status'] === false) {
308 $errorMessage .= "--------\n";
309 $errorMessage .= $result['title'] . ': ' . $result['help'] . "\n";
313 return $errorMessage;