appwrite/src/Appwrite/Platform/Tasks/Install.php

1105 lines
40 KiB
PHP
Raw Normal View History

2022-07-13 07:02:55 +00:00
<?php
2022-07-14 02:04:31 +00:00
2022-11-14 10:01:41 +00:00
namespace Appwrite\Platform\Tasks;
2022-07-13 07:02:55 +00:00
use Appwrite\Docker\Compose;
use Appwrite\Docker\Env;
use Appwrite\Platform\Installer\Server as InstallerServer;
2022-07-13 07:02:55 +00:00
use Appwrite\Utopia\View;
2025-11-04 07:51:03 +00:00
use Utopia\Auth\Proofs\Password;
use Utopia\Auth\Proofs\Token;
2022-07-13 07:02:55 +00:00
use Utopia\Config\Config;
use Utopia\Console;
use Utopia\Fetch\Client;
2024-03-08 12:57:20 +00:00
use Utopia\Platform\Action;
2024-10-08 07:54:40 +00:00
use Utopia\Validator\Boolean;
use Utopia\Validator\Text;
use Utopia\Validator\WhiteList;
2022-07-13 07:02:55 +00:00
2022-07-14 02:04:31 +00:00
class Install extends Action
{
private const int INSTALL_STEP_DELAY_SECONDS = 2;
private const int WEB_SERVER_CHECK_ATTEMPTS = 10;
private const int WEB_SERVER_CHECK_DELAY_SECONDS = 1;
2026-01-30 06:14:00 +00:00
private const int HEALTH_CHECK_ATTEMPTS = 30;
private const int HEALTH_CHECK_DELAY_SECONDS = 3;
2026-01-26 12:18:08 +00:00
private const string PATTERN_ENV_VAR_NAME = '/^[A-Z0-9_]+$/';
private const string PATTERN_DB_PASSWORD_VAR = '/^_APP_DB_.*_PASS$/';
private const string PATTERN_SESSION_COOKIE = '/a_session_console=([^;]+)/';
2026-02-04 09:18:42 +00:00
private const string APPWRITE_API_URL = 'http://appwrite';
2026-01-30 06:14:00 +00:00
private const string GROWTH_API_URL = 'https://growth.appwrite.io/v1';
protected string $hostPath = '';
protected ?bool $isLocalInstall = null;
protected ?array $installerConfig = null;
protected string $path = '/usr/src/code/appwrite';
2022-08-02 01:58:36 +00:00
public static function getName(): string
{
return 'install';
}
2022-07-14 02:04:31 +00:00
2022-07-13 07:02:55 +00:00
public function __construct()
{
$this
->desc('Install Appwrite')
->param('http-port', '', new Text(4), 'Server HTTP port', true)
->param('https-port', '', new Text(4), 'Server HTTPS port', true)
2022-07-13 07:02:55 +00:00
->param('organization', 'appwrite', new Text(0), 'Docker Registry organization', true)
->param('image', 'appwrite', new Text(0), 'Main appwrite docker image', true)
->param('interactive', 'Y', new Text(1), 'Run an interactive session', true)
->param('no-start', false, new Boolean(true), 'Run an interactive session', true)
->param('database', 'mongodb', new WhiteList(['mongodb', 'mariadb', 'postgresql']), 'Database to use (mongodb|mariadb|postgresql)', true)
2025-06-04 08:37:43 +00:00
->callback($this->action(...));
2022-07-13 07:02:55 +00:00
}
public function action(
string $httpPort,
string $httpsPort,
string $organization,
string $image,
string $interactive,
bool $noStart,
string $database
): void {
$isUpgrade = false;
2026-01-26 12:10:19 +00:00
$defaultHttpPort = '80';
$defaultHttpsPort = '443';
2022-07-13 07:02:55 +00:00
$config = Config::getParam('variables');
2025-12-02 10:33:21 +00:00
/** @var array<string, array<string, string>> $vars array where key is variable name and value is variable */
2022-07-13 07:02:55 +00:00
$vars = [];
foreach ($config as $category) {
foreach ($category['variables'] ?? [] as $var) {
$vars[$var['name']] = $var;
2022-07-13 07:02:55 +00:00
}
}
Console::success('Starting Appwrite installation...');
$isLocalInstall = $this->isLocalInstall();
$this->applyLocalPaths($isLocalInstall, true);
2026-01-22 12:42:41 +00:00
// Create directory with write permissions
if (!\file_exists(\dirname($this->path))) {
if (!@\mkdir(\dirname($this->path), 0755, true)) {
Console::error('Can\'t create directory ' . \dirname($this->path));
2022-07-13 07:02:55 +00:00
Console::exit(1);
}
}
2026-01-22 12:42:41 +00:00
// Check for existing installation
$data = $this->readExistingCompose();
$envFileExists = file_exists($this->path . '/' . $this->getEnvFileName());
$existingInstallation = $data !== '' || $envFileExists;
2022-07-13 07:02:55 +00:00
2025-12-02 10:33:21 +00:00
if ($existingInstallation) {
2022-07-13 07:02:55 +00:00
$time = \time();
$composeFileName = $this->getComposeFileName();
Console::info('Compose file found, creating backup: ' . $composeFileName . '.' . $time . '.backup');
file_put_contents($this->path . '/' . $composeFileName . '.' . $time . '.backup', $data);
2022-07-13 07:02:55 +00:00
$compose = new Compose($data);
$appwrite = $compose->getService('appwrite');
2023-10-26 20:25:35 +00:00
$oldVersion = $appwrite?->getImageVersion();
2022-07-13 07:02:55 +00:00
try {
$ports = $compose->getService('traefik')->getPorts();
} catch (\Throwable $th) {
$ports = [
2026-01-26 12:10:19 +00:00
$defaultHttpPort => $defaultHttpPort,
$defaultHttpsPort => $defaultHttpsPort
2022-07-13 07:02:55 +00:00
];
Console::warning('Traefik not found. Falling back to default ports.');
}
if ($oldVersion) {
2025-12-02 10:33:21 +00:00
foreach ($compose->getServices() as $service) {
2022-07-13 07:02:55 +00:00
if (!$service) {
continue;
}
$env = $service->getEnvironment()->list();
foreach ($env as $key => $value) {
if (is_null($value)) {
continue;
}
$configVar = $vars[$key] ?? [];
if (!empty($configVar) && !($configVar['overwrite'] ?? false)) {
$vars[$key]['default'] = $value;
2022-07-13 07:02:55 +00:00
}
}
}
$envData = @file_get_contents($this->path . '/' . $this->getEnvFileName());
2022-07-13 07:02:55 +00:00
2025-12-02 10:33:21 +00:00
if ($envData !== false) {
2026-01-22 12:42:41 +00:00
if (!$isLocalInstall) {
Console::info('Env file found, creating backup: .env.' . $time . '.backup');
file_put_contents($this->path . '/.env.' . $time . '.backup', $envData);
}
2025-12-02 10:33:21 +00:00
$env = new Env($envData);
2022-07-13 07:02:55 +00:00
foreach ($env->list() as $key => $value) {
if (is_null($value)) {
continue;
}
$configVar = $vars[$key] ?? [];
if (!empty($configVar) && !($configVar['overwrite'] ?? false)) {
$vars[$key]['default'] = $value;
2022-07-13 07:02:55 +00:00
}
}
}
foreach ($ports as $key => $value) {
2026-01-26 12:10:19 +00:00
if ($value === $defaultHttpPort) {
$defaultHttpPort = $key;
2022-07-13 07:02:55 +00:00
}
2026-01-26 12:10:19 +00:00
if ($value === $defaultHttpsPort) {
$defaultHttpsPort = $key;
2022-07-13 07:02:55 +00:00
}
}
}
2025-12-17 05:36:23 +00:00
// Block database type changes on existing installations
$existingDatabase = $vars['_APP_DB_ADAPTER']['default'] ?? null;
if ($existingDatabase !== null && $existingDatabase !== $database) {
Console::error("Cannot change database type from '{$existingDatabase}' to '{$database}'.");
Console::error('Changing database types on an existing installation is not supported.');
Console::exit(1);
}
2022-07-13 07:02:55 +00:00
}
2026-01-22 12:42:41 +00:00
// If interactive and web mode enabled, start web server
2025-12-02 10:33:21 +00:00
if ($interactive === 'Y' && Console::isInteractive()) {
Console::success('Starting web installer...');
Console::info('Open your browser at: http://localhost:' . InstallerServer::INSTALLER_WEB_PORT);
2025-12-02 10:33:21 +00:00
Console::info('Press Ctrl+C to cancel installation');
2026-01-26 12:10:19 +00:00
$this->startWebServer($defaultHttpPort, $defaultHttpsPort, $organization, $image, $noStart, $vars);
2025-12-02 10:33:21 +00:00
return;
}
2026-01-22 12:42:41 +00:00
// Fall back to CLI mode
$enableAssistant = false;
$assistantExistsInOldCompose = false;
if ($existingInstallation && isset($compose)) {
try {
$assistantService = $compose->getService('appwrite-assistant');
$assistantExistsInOldCompose = $assistantService !== null;
} catch (\Throwable) {
/* ignore */
}
}
if ($interactive === 'Y' && Console::isInteractive()) {
$prompt = 'Add Appwrite Assistant? (Y/n)' . ($assistantExistsInOldCompose ? ' [Currently enabled]' : '');
$answer = Console::confirm($prompt);
if (empty($answer)) {
$enableAssistant = $assistantExistsInOldCompose;
} else {
$enableAssistant = \strtolower($answer) === 'y';
}
} elseif ($assistantExistsInOldCompose) {
$enableAssistant = true;
}
2022-07-13 07:02:55 +00:00
if (empty($httpPort)) {
2026-01-26 12:10:19 +00:00
$httpPort = Console::confirm('Choose your server HTTP port: (default: ' . $defaultHttpPort . ')');
$httpPort = ($httpPort) ?: $defaultHttpPort;
2022-07-13 07:02:55 +00:00
}
if (empty($httpsPort)) {
2026-01-26 12:10:19 +00:00
$httpsPort = Console::confirm('Choose your server HTTPS port: (default: ' . $defaultHttpsPort . ')');
$httpsPort = ($httpsPort) ?: $defaultHttpsPort;
2022-07-13 07:02:55 +00:00
}
$userInput = [];
foreach ($vars as $var) {
if ($var['name'] === '_APP_ASSISTANT_OPENAI_API_KEY') {
if (!$enableAssistant) {
$userInput[$var['name']] = '';
continue;
}
if (!empty($var['default'])) {
$userInput[$var['name']] = $var['default'];
continue;
}
if (Console::isInteractive() && $interactive === 'Y') {
$userInput[$var['name']] = Console::confirm('Enter your OpenAI API key for Appwrite Assistant:');
if (empty($userInput[$var['name']])) {
Console::warning('No API key provided. Assistant will be disabled.');
$enableAssistant = false;
$userInput[$var['name']] = '';
}
} else {
$userInput[$var['name']] = '';
}
continue;
}
2025-12-02 10:33:21 +00:00
if (!$var['required'] || !Console::isInteractive() || $interactive !== 'Y') {
continue;
}
2022-07-13 07:02:55 +00:00
if ($var['name'] === '_APP_DB_ADAPTER' && $data !== false) {
$input[$var['name']] = $database;
continue;
}
2025-12-02 10:33:21 +00:00
$value = Console::confirm($var['question'] . ' (default: \'' . $var['default'] . '\')');
2022-07-13 07:02:55 +00:00
2025-12-02 10:33:21 +00:00
if (!empty($value)) {
$userInput[$var['name']] = $value;
2022-07-13 07:02:55 +00:00
}
2025-12-02 10:33:21 +00:00
if ($var['filter'] === 'domainTarget' && !empty($value) && $value !== 'localhost') {
Console::warning("\nIf you haven't already done so, set the following record for {$value} on your DNS provider:\n");
$mask = "%-15.15s %-10.10s %-30.30s\n";
printf($mask, "Type", "Name", "Value");
printf($mask, "A or AAAA", "@", "<YOUR PUBLIC IP>");
Console::warning("\nUse 'AAAA' if you're using an IPv6 address and 'A' if you're using an IPv4 address.\n");
}
}
2025-05-21 12:06:50 +00:00
$database = $input['_APP_DB_ADAPTER'];
if ($database === 'postgresql') {
$input['_APP_DB_HOST'] = 'postgresql';
$input['_APP_DB_PORT'] = 5432;
} elseif ($database === 'mongodb') {
$input['_APP_DB_HOST'] = 'mongodb';
$input['_APP_DB_PORT'] = 27017;
} elseif ($database === 'mariadb') {
$input['_APP_DB_HOST'] = 'mariadb';
$input['_APP_DB_PORT'] = 3306;
}
2025-12-02 10:33:21 +00:00
$shouldGenerateSecrets = !$existingInstallation && !$isUpgrade;
$input = $this->prepareEnvironmentVariables($userInput, $vars, $shouldGenerateSecrets);
2026-01-22 11:58:23 +00:00
$this->performInstallation($httpPort, $httpsPort, $organization, $image, $input, $noStart, null, null, $isUpgrade);
2025-12-02 10:33:21 +00:00
}
2026-01-26 12:10:19 +00:00
protected function startWebServer(string $defaultHttpPort, string $defaultHttpsPort, string $organization, string $image, bool $noStart, array $vars, bool $isUpgrade = false, ?string $lockedDatabase = null): void
2025-12-02 10:33:21 +00:00
{
2026-01-25 06:03:05 +00:00
$port = InstallerServer::INSTALLER_WEB_PORT;
@unlink(InstallerServer::INSTALLER_COMPLETE_FILE);
2025-12-02 10:33:21 +00:00
$this->setInstallerConfig([
2026-01-26 12:10:19 +00:00
'defaultHttpPort' => $defaultHttpPort,
'defaultHttpsPort' => $defaultHttpsPort,
'organization' => $organization,
'image' => $image,
'noStart' => $noStart,
'vars' => $vars,
'isUpgrade' => $isUpgrade,
'lockedDatabase' => $lockedDatabase,
'isLocal' => $this->isLocalInstall(),
'hostPath' => $this->hostPath ?: null,
]);
// Start Swoole-based installer server in background
// Redirect stdout/stderr to a log file so exec() returns immediately
// (otherwise the backgrounded process holds the pipe open and exec() hangs)
$serverScript = \escapeshellarg(dirname(__DIR__) . '/Installer/Server.php');
$logFile = \sys_get_temp_dir() . '/appwrite-installer-server.log';
2026-01-22 11:58:23 +00:00
$output = [];
\exec("php {$serverScript} > " . \escapeshellarg($logFile) . " 2>&1 & echo \$!", $output);
2026-01-22 11:58:23 +00:00
$pid = isset($output[0]) ? (int) $output[0] : 0;
\register_shutdown_function(function () use ($pid) {
2026-01-22 11:58:23 +00:00
if ($pid > 0 && \function_exists('posix_kill')) {
@\posix_kill($pid, SIGTERM);
}
});
\sleep(1);
2025-12-02 10:33:21 +00:00
if (!$this->waitForWebServer($port)) {
$log = @\file_get_contents($logFile);
if ($log !== false && $log !== '') {
Console::error('Installer server log:');
Console::error($log);
}
Console::warning('Web installer did not respond in time. Please refresh the browser.');
return;
2025-12-02 10:33:21 +00:00
}
2026-01-25 06:03:05 +00:00
if ($this->isInstallationComplete($port)) {
Console::success('Installation completed.');
2025-12-02 10:33:21 +00:00
}
}
public function prepareEnvironmentVariables(array $userInput, array $vars, bool $shouldGenerateSecrets = true): array
2025-12-02 10:33:21 +00:00
{
$input = [];
$password = new Password();
$token = new Token();
2026-01-22 12:42:41 +00:00
// Start with all defaults
2025-12-02 10:33:21 +00:00
foreach ($vars as $var) {
2026-01-26 11:56:18 +00:00
$filter = $var['filter'] ?? null;
$default = $var['default'] ?? null;
$hasDefault = $default !== null && $default !== '';
2026-01-26 11:56:18 +00:00
if ($filter === 'token') {
if ($hasDefault) {
$input[$var['name']] = $default;
} elseif ($shouldGenerateSecrets) {
$input[$var['name']] = $token->generate();
} else {
$input[$var['name']] = '';
}
2026-01-26 11:56:18 +00:00
} elseif ($filter === 'password') {
if ($hasDefault) {
$input[$var['name']] = $default;
} elseif ($shouldGenerateSecrets) {
2026-01-26 11:56:18 +00:00
/*;#+@:/?& broke DSNs locally */
$input[$var['name']] = $this->generatePasswordValue($var['name'], $password);
} else {
$input[$var['name']] = '';
}
2025-12-02 10:33:21 +00:00
} else {
$input[$var['name']] = $default;
2022-07-13 07:02:55 +00:00
}
2025-12-02 10:33:21 +00:00
}
2022-10-14 09:32:17 +00:00
2026-01-22 12:42:41 +00:00
// Override with user inputs
2025-12-02 10:33:21 +00:00
foreach ($userInput as $key => $value) {
if ($value !== null && ($value !== '' || $key === '_APP_ASSISTANT_OPENAI_API_KEY')) {
2025-12-02 10:33:21 +00:00
$input[$key] = $value;
2022-10-14 09:32:17 +00:00
}
2022-07-13 07:02:55 +00:00
}
foreach ($input as $key => $value) {
if (!is_string($value)) {
continue;
}
if (str_contains($value, "\n") || str_contains($value, "\r")) {
throw new \InvalidArgumentException('Invalid value for ' . $key);
}
}
2026-01-22 12:42:41 +00:00
// Set database-specific connection details
2025-12-02 10:33:21 +00:00
$database = $input['_APP_DB_ADAPTER'] ?? 'mongodb';
if ($database === 'mongodb') {
$input['_APP_DB_HOST'] = 'mongodb';
$input['_APP_DB_PORT'] = 27017;
} elseif ($database === 'mariadb') {
$input['_APP_DB_HOST'] = 'mariadb';
$input['_APP_DB_PORT'] = 3306;
} elseif ($database === 'postgresql') {
2026-02-26 12:29:38 +00:00
$input['_APP_DB_HOST'] = 'postgresql';
$input['_APP_DB_PORT'] = 5432;
2025-12-02 10:33:21 +00:00
}
return $input;
}
public function hasExistingConfig(): bool
{
$isLocalInstall = $this->isLocalInstall();
$this->applyLocalPaths($isLocalInstall, true);
if ($this->readExistingCompose() !== '') {
return true;
}
return file_exists($this->path . '/' . $this->getEnvFileName());
}
2026-01-30 06:14:00 +00:00
private function updateProgress(?callable $progress, string $step, string $status, array $messages = [], array $details = [], ?string $messageOverride = null): void
2026-01-22 11:58:23 +00:00
{
if (!$progress) {
return;
}
if ($messageOverride !== null) {
$message = $messageOverride;
} else {
$key = $status === InstallerServer::STATUS_COMPLETED ? 'done' : 'start';
$message = $messages[$step][$key] ?? null;
if ($message === null) {
return;
}
}
2026-01-22 11:58:23 +00:00
try {
$progress($step, $status, $message, $details);
} catch (\Throwable $e) {
}
if ($status === InstallerServer::STATUS_IN_PROGRESS) {
sleep(self::INSTALL_STEP_DELAY_SECONDS);
}
2026-01-22 11:58:23 +00:00
}
private function setInstallerConfig(array $config): void
2026-01-22 11:58:23 +00:00
{
$json = json_encode($config, JSON_UNESCAPED_SLASHES);
if (!is_string($json)) {
return;
2026-01-22 11:58:23 +00:00
}
putenv('APPWRITE_INSTALLER_CONFIG=' . $json);
$path = InstallerServer::INSTALLER_CONFIG_FILE;
if (@file_put_contents($path, $json) === false) {
return;
}
@chmod($path, 0600);
2026-01-22 11:58:23 +00:00
}
2025-12-02 10:33:21 +00:00
public function performInstallation(
string $httpPort,
string $httpsPort,
string $organization,
string $image,
array $input,
2026-01-22 11:58:23 +00:00
bool $noStart,
?callable $progress = null,
?string $resumeFromStep = null,
bool $isUpgrade = false,
array $account = []
2025-12-02 10:33:21 +00:00
): void {
$isLocalInstall = $this->isLocalInstall();
$this->applyLocalPaths($isLocalInstall, false);
2025-12-02 10:33:21 +00:00
$isCLI = php_sapi_name() === 'cli';
if ($isLocalInstall) {
$useExistingConfig = false;
} else {
$useExistingConfig = file_exists($this->path . '/' . $this->getComposeFileName())
&& file_exists($this->path . '/' . $this->getEnvFileName());
}
2025-12-02 10:33:21 +00:00
if ($isLocalInstall) {
2026-01-22 11:58:23 +00:00
$image = 'appwrite';
$organization = 'appwrite';
2026-01-22 11:58:23 +00:00
}
$templateForEnv = new View($this->buildFromProjectPath('/app/views/install/env.phtml'));
$templateForCompose = new View($this->buildFromProjectPath('/app/views/install/compose.phtml'));
2022-07-13 07:02:55 +00:00
2025-12-02 10:33:21 +00:00
$database = $input['_APP_DB_ADAPTER'] ?? 'mongodb';
2026-01-22 11:58:23 +00:00
$version = \defined('APP_VERSION_STABLE') ? APP_VERSION_STABLE : 'latest';
if ($isLocalInstall) {
2026-01-22 11:58:23 +00:00
$version = 'local';
}
$assistantKey = (string) ($input['_APP_ASSISTANT_OPENAI_API_KEY'] ?? '');
$enableAssistant = trim($assistantKey) !== '';
2022-07-13 07:02:55 +00:00
$templateForCompose
->setParam('httpPort', $httpPort)
->setParam('httpsPort', $httpsPort)
2026-01-22 11:58:23 +00:00
->setParam('version', $version)
2022-07-13 07:02:55 +00:00
->setParam('organization', $organization)
2025-12-02 10:33:21 +00:00
->setParam('image', $image)
->setParam('database', $database)
->setParam('hostPath', $this->hostPath)
->setParam('enableAssistant', $enableAssistant);
2022-07-13 07:02:55 +00:00
2023-08-28 22:09:37 +00:00
$templateForEnv->setParam('vars', $input);
2022-07-13 07:02:55 +00:00
$steps = [
InstallerServer::STEP_DOCKER_COMPOSE,
InstallerServer::STEP_ENV_VARS,
InstallerServer::STEP_DOCKER_CONTAINERS
];
2026-01-22 11:58:23 +00:00
$startIndex = 0;
if ($resumeFromStep !== null) {
$resumeIndex = array_search($resumeFromStep, $steps, true);
if ($resumeIndex !== false) {
$startIndex = $resumeIndex;
}
2022-07-13 07:02:55 +00:00
}
2026-01-22 11:58:23 +00:00
$currentStep = null;
$messages = $this->buildStepMessages($isUpgrade);
2022-07-13 07:02:55 +00:00
2026-01-22 11:58:23 +00:00
try {
if ($startIndex <= 1) {
$this->updateProgress($progress, InstallerServer::STEP_CONFIG_FILES, InstallerServer::STATUS_IN_PROGRESS, $messages);
2022-07-13 07:02:55 +00:00
}
2026-01-22 11:58:23 +00:00
if ($startIndex <= 0) {
$currentStep = InstallerServer::STEP_DOCKER_COMPOSE;
$this->updateProgress($progress, InstallerServer::STEP_DOCKER_COMPOSE, InstallerServer::STATUS_IN_PROGRESS, $messages);
2026-01-22 11:58:23 +00:00
2026-01-22 12:42:41 +00:00
if (!$useExistingConfig) {
$this->writeComposeFile($templateForCompose);
2025-12-02 10:33:21 +00:00
}
2026-01-22 11:58:23 +00:00
$this->updateProgress($progress, InstallerServer::STEP_DOCKER_COMPOSE, InstallerServer::STATUS_COMPLETED, $messages);
2025-12-02 10:33:21 +00:00
}
2022-07-13 07:02:55 +00:00
2026-01-22 11:58:23 +00:00
if ($startIndex <= 1) {
$currentStep = InstallerServer::STEP_ENV_VARS;
$this->updateProgress($progress, InstallerServer::STEP_ENV_VARS, InstallerServer::STATUS_IN_PROGRESS, $messages);
2026-01-22 11:58:23 +00:00
2026-01-22 12:42:41 +00:00
if (!$useExistingConfig) {
$this->writeEnvFile($templateForEnv);
2026-01-22 11:58:23 +00:00
}
$this->updateProgress($progress, InstallerServer::STEP_ENV_VARS, InstallerServer::STATUS_COMPLETED, $messages);
$this->updateProgress($progress, InstallerServer::STEP_CONFIG_FILES, InstallerServer::STATUS_COMPLETED, $messages);
2025-12-02 10:33:21 +00:00
}
2026-01-22 12:42:41 +00:00
if ($database === 'mongodb' && !$useExistingConfig) {
$this->copyMongoEntrypointIfNeeded();
2025-12-02 10:33:21 +00:00
}
2026-01-22 11:58:23 +00:00
if (!$noStart && $startIndex <= 2) {
$currentStep = InstallerServer::STEP_DOCKER_CONTAINERS;
$this->updateProgress($progress, InstallerServer::STEP_DOCKER_CONTAINERS, InstallerServer::STATUS_IN_PROGRESS, $messages);
$this->runDockerCompose($input, $isLocalInstall, $useExistingConfig, $isCLI);
2026-03-02 11:46:51 +00:00
if (!$isLocalInstall) {
$this->connectInstallerToAppwriteNetwork();
}
$domain = $input['_APP_DOMAIN'] ?? 'localhost';
// Wait for Appwrite API to be healthy before marking containers as ready
$apiUrl = $this->waitForApiReady($domain, $httpPort, $isLocalInstall, $progress, InstallerServer::STEP_DOCKER_CONTAINERS);
2026-01-22 11:58:23 +00:00
$this->updateProgress($progress, InstallerServer::STEP_DOCKER_CONTAINERS, InstallerServer::STATUS_COMPLETED, $messages);
2026-01-22 11:58:23 +00:00
if (!$isUpgrade) {
$this->createInitialAdminAccount($account, $progress, $apiUrl, $domain);
}
// Track installs
2026-01-30 06:14:00 +00:00
$this->trackSelfHostedInstall($input, $isUpgrade, $version, $account);
2026-01-22 11:58:23 +00:00
if ($isCLI) {
Console::success('Appwrite installed successfully');
}
} else {
if ($isCLI) {
Console::success('Installation files created. Run "docker compose up -d" to start Appwrite');
}
2025-12-02 10:33:21 +00:00
}
2026-01-22 11:58:23 +00:00
} catch (\Throwable $e) {
if ($currentStep) {
$details = [
'trace' => $e->getTraceAsString()
];
$previous = $e->getPrevious();
if ($previous instanceof \Throwable && $previous->getMessage() !== '') {
$details['output'] = $previous->getMessage();
}
$this->updateProgress($progress, $currentStep, InstallerServer::STATUS_ERROR, $messages, $details, $e->getMessage());
2025-12-02 10:33:21 +00:00
}
2026-01-22 11:58:23 +00:00
throw $e;
2022-07-13 07:02:55 +00:00
}
}
private function createInitialAdminAccount(array $account, ?callable $progress, string $apiUrl, string $domain): void
{
$name = $account['name'] ?? 'Admin';
$email = $account['email'] ?? null;
$password = $account['password'] ?? null;
if (!$email || !$password) {
return;
}
try {
$this->updateProgress(
$progress,
InstallerServer::STEP_ACCOUNT_SETUP,
InstallerServer::STATUS_IN_PROGRESS,
messageOverride: 'Creating Appwrite account'
);
// API is already confirmed healthy — just create the account
$userId = $this->makeApiCall('/v1/account', [
'userId' => 'unique()',
'email' => $email,
'password' => $password,
'name' => $name
], false, $apiUrl, $domain);
$session = $this->makeApiCall('/v1/account/sessions/email', [
'email' => $email,
'password' => $password
], true, $apiUrl, $domain);
$this->updateProgress(
$progress,
InstallerServer::STEP_ACCOUNT_SETUP,
InstallerServer::STATUS_COMPLETED,
details: [
'userId' => $userId,
'sessionId' => $session['id'],
2026-03-02 11:46:51 +00:00
'sessionSecret' => $session['secret'],
'sessionExpire' => $session['expire'] ?? null
],
messageOverride: 'Account created successfully'
);
} catch (\Throwable $e) {
$this->updateProgress(
$progress,
InstallerServer::STEP_ACCOUNT_SETUP,
InstallerServer::STATUS_ERROR,
details: [
'output' => "apiUrl={$apiUrl}, domain={$domain}",
'trace' => $e->getTraceAsString(),
],
messageOverride: 'Account creation failed: ' . $e->getMessage()
);
}
}
2026-01-30 06:14:00 +00:00
private function trackSelfHostedInstall(array $input, bool $isUpgrade, string $version, array $account): void
{
if ($this->isLocalInstall()) {
return;
}
$appEnv = $input['_APP_ENV'] ?? 'development';
$domain = $input['_APP_DOMAIN'] ?? 'localhost';
/* local or test instance */
if ($appEnv !== 'production') {
return;
}
/* prod but local or test instance */
if ($domain === 'localhost'
|| str_starts_with($domain, '127.')
|| str_starts_with($domain, '0.0.0.0')
) {
return;
}
$type = $isUpgrade ? 'upgrade' : 'install';
$database = $input['_APP_DB_ADAPTER'] ?? 'mongodb';
$name = $account['name'] ?? 'Admin';
$email = $account['email'] ?? 'admin@selfhosted.local';
2026-01-30 06:14:00 +00:00
$payload = [
'action' => $type,
'account' => 'self-hosted',
'url' => 'https://' . $domain,
'category' => 'self_hosted',
'label' => 'self_hosted_' . $type,
2026-01-30 06:41:39 +00:00
'version' => $version,
'data' => json_encode([
'name' => $name,
'email' => $email,
'domain' => $domain,
'database' => $database,
]),
2026-01-30 06:14:00 +00:00
];
try {
$client = new Client();
$client
->addHeader('Content-Type', 'application/json')
->fetch(self::GROWTH_API_URL . '/analytics', Client::METHOD_POST, $payload);
2026-01-30 06:14:00 +00:00
} catch (\Throwable) {
// tracking shouldn't block installation
}
}
/**
* Wait for the Appwrite API to respond. Builds candidate URLs based on
* the runtime context and returns whichever responds first.
*
* Candidates (in order of preference):
* - Docker internal DNS (http://appwrite) only if on the appwrite network
* - host.docker.internal:{port} reaches host-published ports from inside a container
* - localhost:{port} works when running directly on the host (local dev)
*/
private function waitForApiReady(string $domain, string $httpPort, bool $isLocalInstall, ?callable $progress, string $step = InstallerServer::STEP_DOCKER_CONTAINERS): string
{
$client = new Client();
$client
->setTimeout(5000)
->setConnectTimeout(5000)
->addHeader('Host', $domain);
$healthPath = '/v1/health/version';
// Local dev: reach Traefik via localhost on the host.
// Docker: reach Appwrite directly via Docker internal DNS (network connect is guaranteed).
$candidate = $isLocalInstall
? 'http://localhost:' . $httpPort . $healthPath
: self::APPWRITE_API_URL . $healthPath;
$candidates = [$candidate];
$lastErrors = [];
for ($i = 0; $i < self::HEALTH_CHECK_ATTEMPTS; $i++) {
foreach ($candidates as $url) {
try {
$response = $client->fetch($url);
if ($response->getStatusCode() === 200) {
return \rtrim(\substr($url, 0, -\strlen($healthPath)), '/');
}
$lastErrors[$url] = "HTTP {$response->getStatusCode()}";
} catch (\Throwable $e) {
$lastErrors[$url] = $e->getMessage();
}
}
if ($progress) {
try {
$progress(
$step,
InstallerServer::STATUS_IN_PROGRESS,
'Waiting for Appwrite to be ready (' . ($i + 1) . '/' . self::HEALTH_CHECK_ATTEMPTS . ')',
[]
);
} catch (\Throwable) {
}
}
if ($i < self::HEALTH_CHECK_ATTEMPTS - 1) {
sleep(self::HEALTH_CHECK_DELAY_SECONDS);
}
}
$errorDetail = implode('; ', array_map(
fn ($url, $err) => "{$url} => {$err}",
array_keys($lastErrors),
array_values($lastErrors)
));
throw new \Exception("Failed to connect with Appwrite in time. Tried: {$errorDetail}");
}
/**
* Connect the installer container to the appwrite network, retrying
* until it succeeds or we run out of attempts.
*/
private function connectInstallerToAppwriteNetwork(): void
{
$network = escapeshellarg('appwrite');
// Resolve our own container ID — works regardless of how the
// container was started (--name, random name, etc.).
$containerId = trim((string) @file_get_contents('/etc/hostname'));
if ($containerId === '') {
$containerId = InstallerServer::DEFAULT_CONTAINER;
}
$container = escapeshellarg($containerId);
$outputStr = '';
for ($i = 0; $i < 10; $i++) {
$output = [];
@exec("docker network connect {$network} {$container} 2>&1", $output, $exitCode);
if ($exitCode === 0) {
return;
}
$outputStr = implode(' ', $output);
if (str_contains($outputStr, 'already exists')) {
return;
}
sleep(1);
}
throw new \Exception('Failed to connect installer to appwrite network: ' . $outputStr);
}
private function makeApiCall(string $endpoint, array $body, bool $extractSession = false, string $apiUrl = self::APPWRITE_API_URL, string $domain = 'localhost')
{
$client = new Client();
$client
->setTimeout(30000)
->setConnectTimeout(10000)
->addHeader('Content-Type', 'application/json')
->addHeader('X-Appwrite-Project', 'console')
->addHeader('Host', $domain);
2026-03-02 11:46:51 +00:00
$url = $apiUrl . $endpoint;
$response = $client->fetch($url, Client::METHOD_POST, $body);
if ($response->getStatusCode() !== 201) {
$error = $response->json();
$message = $error['message'] ?? ('HTTP ' . $response->getStatusCode() . ': ' . $response->getBody());
throw new \Exception("API call failed ({$endpoint}): {$message}");
}
$data = $response->json();
if (!isset($data['$id'])) {
throw new \Exception('API response missing ID field');
}
if ($extractSession) {
$headers = $response->getHeaders();
$setCookie = $headers['set-cookie'] ?? $headers['Set-Cookie'] ?? null;
2026-01-26 12:18:08 +00:00
if (!$setCookie || !preg_match(self::PATTERN_SESSION_COOKIE, $setCookie, $matches)) {
throw new \Exception('Session created but no cookie found');
}
return [
'id' => $data['$id'],
'secret' => $matches[1],
'expire' => $data['expire'] ?? null
];
}
return $data['$id'];
}
private function buildStepMessages(bool $isUpgrade): array
{
$isUpgradeLabel = $isUpgrade ? 'updated' : 'created';
$verbs = [
InstallerServer::STEP_CONFIG_FILES => $isUpgrade ? 'Updating' : 'Creating',
InstallerServer::STEP_DOCKER_COMPOSE => $isUpgrade ? 'Updating' : 'Generating',
InstallerServer::STEP_ENV_VARS => $isUpgrade ? 'Updating' : 'Configuring',
InstallerServer::STEP_DOCKER_CONTAINERS => $isUpgrade ? 'Restarting' : 'Starting',
];
return [
InstallerServer::STEP_CONFIG_FILES => [
'start' => $verbs[InstallerServer::STEP_CONFIG_FILES] . ' configuration files...',
'done' => 'Configuration files ' . $isUpgradeLabel,
],
InstallerServer::STEP_DOCKER_COMPOSE => [
'start' => $verbs[InstallerServer::STEP_DOCKER_COMPOSE] . ' Docker Compose file...',
'done' => 'Docker Compose file ' . $isUpgradeLabel,
],
InstallerServer::STEP_ENV_VARS => [
'start' => $verbs[InstallerServer::STEP_ENV_VARS] . ' environment variables...',
'done' => 'Environment variables ' . $isUpgradeLabel,
],
InstallerServer::STEP_DOCKER_CONTAINERS => [
'start' => $verbs[InstallerServer::STEP_DOCKER_CONTAINERS] . ' Docker containers...',
'done' => $isUpgrade ? 'Docker containers restarted' : 'Docker containers started',
],
];
}
private function writeComposeFile(View $template): void
{
$composeFileName = $this->getComposeFileName();
$targetPath = $this->path . '/' . $composeFileName;
$renderedContent = $template->render(false);
$result = @file_put_contents($targetPath, $renderedContent);
if ($result === false) {
$lastError = error_get_last();
$errorMsg = $lastError ? $lastError['message'] : 'Unknown error';
throw new \Exception('Failed to save Docker Compose file: ' . $errorMsg . ' (path: ' . $targetPath . ')');
}
}
private function writeEnvFile(View $template): void
{
$envFileName = $this->getEnvFileName();
if (!\file_put_contents($this->path . '/' . $envFileName, $template->render(false))) {
throw new \Exception('Failed to save environment variables file');
}
}
private function copyMongoEntrypointIfNeeded(): void
{
$mongoEntrypoint = $this->buildFromProjectPath('/mongo-entrypoint.sh');
if (file_exists($mongoEntrypoint)) {
// Always use container path for file operations
copy($mongoEntrypoint, $this->path . '/mongo-entrypoint.sh');
}
}
protected function runDockerCompose(array $input, bool $isLocalInstall, bool $useExistingConfig, bool $isCLI): void
{
$env = '';
if (!$useExistingConfig) {
foreach ($input as $key => $value) {
if ($value === null || $value === '') {
continue;
}
2026-01-26 12:18:08 +00:00
if (!preg_match(self::PATTERN_ENV_VAR_NAME, $key)) {
throw new \Exception("Invalid environment variable name: $key");
}
$env .= $key . '=' . \escapeshellarg((string) $value) . ' ';
}
}
if ($isCLI) {
Console::log("Running \"docker compose up -d --remove-orphans --renew-anon-volumes\"");
}
$composeFileName = $this->getComposeFileName();
$composeFile = $this->path . '/' . $composeFileName;
$command = [
'docker',
'compose',
'-f',
$composeFile,
];
if ($isLocalInstall) {
$command[] = '--project-name';
$command[] = 'appwrite';
}
$command[] = '--project-directory';
$command[] = $this->path;
$command[] = 'up';
$command[] = '-d';
$command[] = '--remove-orphans';
$command[] = '--renew-anon-volumes';
2026-01-26 12:05:13 +00:00
$commandLine = $env . implode(' ', array_map(escapeshellarg(...), $command)) . ' 2>&1';
\exec($commandLine, $output, $exit);
if ($exit !== 0) {
$message = trim(implode("\n", $output));
$previous = $message !== '' ? new \RuntimeException($message) : null;
throw new \RuntimeException('Failed to start containers', 0, $previous);
}
if ($isLocalInstall && $isCLI && !empty($output)) {
Console::log(implode("\n", $output));
}
}
protected function isLocalInstall(): bool
{
if ($this->isLocalInstall === null) {
$config = $this->readInstallerConfig();
$this->isLocalInstall = !empty($config['isLocal']);
}
return $this->isLocalInstall;
}
protected function readInstallerConfig(): array
{
if ($this->installerConfig !== null) {
return $this->installerConfig;
}
$this->installerConfig = [];
$decodeConfig = static function (string $json): ?array {
$decoded = json_decode($json, true);
return is_array($decoded) ? $decoded : null;
};
$json = getenv('APPWRITE_INSTALLER_CONFIG');
$path = InstallerServer::INSTALLER_CONFIG_FILE;
$fileJson = file_exists($path) ? file_get_contents($path) : null;
foreach ([$json, $fileJson] as $candidate) {
if (!is_string($candidate) || $candidate === '') {
continue;
}
$decoded = $decodeConfig($candidate);
if ($decoded !== null) {
$this->installerConfig = $decoded;
return $this->installerConfig;
}
}
return $this->installerConfig;
}
protected function getInstallerHostPath(): string
{
$config = $this->readInstallerConfig();
if (!empty($config['hostPath'])) {
return (string) $config['hostPath'];
}
$cwd = getcwd();
return $cwd !== false ? $cwd : '.';
}
protected function buildFromProjectPath(string $suffix): string
{
if ($suffix !== '' && $suffix[0] !== '/') {
$suffix = '/' . $suffix;
}
return dirname(__DIR__, 4) . $suffix;
}
protected function applyLocalPaths(bool $isLocalInstall, bool $force = false): void
{
if (!$isLocalInstall) {
return;
}
if (!$force && $this->hostPath !== '') {
return;
}
$this->path = '/usr/src/code';
$this->hostPath = $this->getInstallerHostPath();
}
protected function readExistingCompose(): string
{
$composeFile = $this->path . '/' . $this->getComposeFileName();
$data = @file_get_contents($composeFile);
return !empty($data) ? $data : '';
}
protected function generatePasswordValue(string $varName, Password $password): string
{
$value = $password->generate();
2026-01-26 12:18:08 +00:00
if (!\preg_match(self::PATTERN_DB_PASSWORD_VAR, $varName)) {
return $value;
}
return rtrim(strtr(base64_encode(hash('sha256', $value, true)), '+/', '-_'), '=');
}
protected function getComposeFileName(): string
{
return $this->isLocalInstall() ? 'docker-compose.web-installer.yml' : 'docker-compose.yml';
}
protected function getEnvFileName(): string
{
return $this->isLocalInstall() ? '.env.web-installer' : '.env';
}
2026-01-25 06:03:05 +00:00
private function isInstallationComplete(int $port): bool
{
while (true) {
if (file_exists(InstallerServer::INSTALLER_COMPLETE_FILE)) {
return true;
}
$handle = @fsockopen('localhost', $port, $errno, $errstr, 1);
if ($handle === false) {
return false;
}
\fclose($handle);
\sleep(1);
}
}
private function waitForWebServer(int $port): bool
{
for ($attempt = 0; $attempt < self::WEB_SERVER_CHECK_ATTEMPTS; $attempt++) {
$handle = @fsockopen('localhost', $port, $errno, $errstr, 1);
if ($handle !== false) {
\fclose($handle);
return true;
}
\sleep(self::WEB_SERVER_CHECK_DELAY_SECONDS);
}
return false;
}
2022-07-14 02:04:31 +00:00
}