mirror of
https://github.com/coollabsio/coolify.git
synced 2026-11-04 10:42:23 +00:00
Andras BacsaiandClaude Opus 5.5
a6a3b1d26b
Revert the app code changes ofd666a0a95,69eeb2f62,1e66c9f9banda32082b03, so login, registration, OAuth, team danger zone, service templates, and the other touched files are back to their earlier state. Keep the removal of unused components and markup-only tests (d666a0a95also contained those deletions by mistake). StartupExecutionCleanupTest now fakes the template CDN with the current file content, so app:init in the test no longer empties templates/service-templates-latest.json. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
1032 lines
40 KiB
PHP
1032 lines
40 KiB
PHP
<?php
|
|
|
|
namespace App\Http\Controllers\Api;
|
|
|
|
use App\Actions\Server\DeleteServer;
|
|
use App\Actions\Server\ValidateServer;
|
|
use App\Enums\ProxyStatus;
|
|
use App\Enums\ProxyTypes;
|
|
use App\Enums\ServerRole;
|
|
use App\Http\Controllers\Controller;
|
|
use App\Jobs\DeleteResourceJob;
|
|
use App\Jobs\ValidateAndInstallServerJob;
|
|
use App\Models\Application;
|
|
use App\Models\PrivateKey;
|
|
use App\Models\Project;
|
|
use App\Models\Server as ModelsServer;
|
|
use App\Models\Team;
|
|
use App\Rules\ValidServerIp;
|
|
use App\Support\ValidationPatterns;
|
|
use Illuminate\Http\JsonResponse;
|
|
use Illuminate\Http\Request;
|
|
use Illuminate\Validation\ValidationException;
|
|
use OpenApi\Attributes as OA;
|
|
use Stringable;
|
|
|
|
class ServersController extends Controller
|
|
{
|
|
private function removeSensitiveDataFromSettings($settings)
|
|
{
|
|
if (request()->attributes->get('can_read_sensitive', false) === true) {
|
|
$settings = $settings->makeVisible([
|
|
'sentinel_token',
|
|
'sentinel_custom_url',
|
|
'logdrain_newrelic_license_key',
|
|
'logdrain_axiom_api_key',
|
|
'logdrain_custom_config',
|
|
'logdrain_custom_config_parser',
|
|
]);
|
|
}
|
|
|
|
return serializeApiResponse($settings);
|
|
}
|
|
|
|
private function removeSensitiveData($server)
|
|
{
|
|
$server->makeHidden([
|
|
'id',
|
|
]);
|
|
if (request()->attributes->get('can_read_sensitive', false) === true) {
|
|
$server->makeVisible([
|
|
'logdrain_axiom_api_key',
|
|
'logdrain_newrelic_license_key',
|
|
]);
|
|
}
|
|
|
|
return serializeApiResponse($server);
|
|
}
|
|
|
|
#[OA\Get(
|
|
summary: 'List',
|
|
description: 'List all servers.',
|
|
path: '/servers',
|
|
operationId: 'list-servers',
|
|
security: [
|
|
['bearerAuth' => []],
|
|
],
|
|
tags: ['Servers'],
|
|
responses: [
|
|
new OA\Response(
|
|
response: 200,
|
|
description: 'Get all servers.',
|
|
content: [
|
|
new OA\MediaType(
|
|
mediaType: 'application/json',
|
|
schema: new OA\Schema(
|
|
type: 'array',
|
|
items: new OA\Items(ref: '#/components/schemas/Server')
|
|
)
|
|
),
|
|
]),
|
|
new OA\Response(
|
|
response: 401,
|
|
ref: '#/components/responses/401',
|
|
),
|
|
new OA\Response(
|
|
response: 400,
|
|
ref: '#/components/responses/400',
|
|
),
|
|
]
|
|
)]
|
|
public function servers(Request $request)
|
|
{
|
|
$teamId = getTeamIdFromToken();
|
|
if (is_null($teamId)) {
|
|
return invalidTokenResponse();
|
|
}
|
|
$servers = ModelsServer::whereTeamId($teamId)->select('id', 'name', 'uuid', 'ip', 'user', 'port', 'description')->get()->load(['settings'])->map(function ($server) {
|
|
$server['is_reachable'] = $server->settings->is_reachable;
|
|
$server['is_usable'] = $server->settings->is_usable;
|
|
|
|
return $server;
|
|
});
|
|
$servers = $servers->map(function ($server) {
|
|
$settings = $this->removeSensitiveDataFromSettings($server->settings);
|
|
$server = $this->removeSensitiveData($server);
|
|
data_set($server, 'settings', $settings);
|
|
|
|
return $server;
|
|
});
|
|
|
|
return response()->json($servers);
|
|
}
|
|
|
|
#[OA\Get(
|
|
summary: 'Get',
|
|
description: 'Get server by UUID.',
|
|
path: '/servers/{uuid}',
|
|
operationId: 'get-server-by-uuid',
|
|
security: [
|
|
['bearerAuth' => []],
|
|
],
|
|
tags: ['Servers'],
|
|
parameters: [
|
|
new OA\Parameter(name: 'uuid', in: 'path', required: true, description: 'Server\'s UUID', schema: new OA\Schema(type: 'string')),
|
|
],
|
|
responses: [
|
|
new OA\Response(
|
|
response: 200,
|
|
description: 'Get server by UUID',
|
|
content: [
|
|
new OA\MediaType(
|
|
mediaType: 'application/json',
|
|
schema: new OA\Schema(
|
|
ref: '#/components/schemas/Server'
|
|
)
|
|
),
|
|
]),
|
|
new OA\Response(
|
|
response: 401,
|
|
ref: '#/components/responses/401',
|
|
),
|
|
new OA\Response(
|
|
response: 400,
|
|
ref: '#/components/responses/400',
|
|
),
|
|
new OA\Response(
|
|
response: 404,
|
|
ref: '#/components/responses/404',
|
|
),
|
|
]
|
|
)]
|
|
public function server_by_uuid(Request $request)
|
|
{
|
|
$with_resources = $request->query('resources');
|
|
$teamId = getTeamIdFromToken();
|
|
if (is_null($teamId)) {
|
|
return invalidTokenResponse();
|
|
}
|
|
$server = ModelsServer::whereTeamId($teamId)->whereUuid(request()->uuid)->first();
|
|
if (is_null($server)) {
|
|
return response()->json(['message' => 'Server not found.'], 404);
|
|
}
|
|
$this->authorize('view', $server);
|
|
if ($with_resources) {
|
|
$server['resources'] = $server->definedResources()->map(function ($resource) {
|
|
$payload = [
|
|
'id' => $resource->id,
|
|
'uuid' => $resource->uuid,
|
|
'name' => $resource->name,
|
|
'type' => $resource->type(),
|
|
'created_at' => $resource->created_at,
|
|
'updated_at' => $resource->updated_at,
|
|
];
|
|
$payload['status'] = $resource->status;
|
|
|
|
return $payload;
|
|
});
|
|
} else {
|
|
$server->load(['settings']);
|
|
}
|
|
|
|
$settings = $this->removeSensitiveDataFromSettings($server->settings);
|
|
$server = $this->removeSensitiveData($server);
|
|
data_set($server, 'settings', $settings);
|
|
|
|
return response()->json(serializeApiResponse($server));
|
|
}
|
|
|
|
#[OA\Get(
|
|
summary: 'Resources',
|
|
description: 'Get resources by server.',
|
|
path: '/servers/{uuid}/resources',
|
|
operationId: 'get-resources-by-server-uuid',
|
|
security: [
|
|
['bearerAuth' => []],
|
|
],
|
|
tags: ['Servers'],
|
|
parameters: [
|
|
new OA\Parameter(name: 'uuid', in: 'path', required: true, description: 'Server\'s UUID', schema: new OA\Schema(type: 'string')),
|
|
],
|
|
responses: [
|
|
new OA\Response(
|
|
response: 200,
|
|
description: 'Get resources by server',
|
|
content: [
|
|
new OA\MediaType(
|
|
mediaType: 'application/json',
|
|
schema: new OA\Schema(
|
|
type: 'array',
|
|
items: new OA\Items(
|
|
type: 'object',
|
|
properties: [
|
|
'id' => ['type' => 'integer'],
|
|
'uuid' => ['type' => 'string'],
|
|
'name' => ['type' => 'string'],
|
|
'type' => ['type' => 'string'],
|
|
'created_at' => ['type' => 'string'],
|
|
'updated_at' => ['type' => 'string'],
|
|
'status' => ['type' => 'string'],
|
|
]
|
|
)
|
|
)),
|
|
]),
|
|
new OA\Response(
|
|
response: 401,
|
|
ref: '#/components/responses/401',
|
|
),
|
|
new OA\Response(
|
|
response: 400,
|
|
ref: '#/components/responses/400',
|
|
),
|
|
]
|
|
)]
|
|
public function resources_by_server(Request $request)
|
|
{
|
|
$teamId = getTeamIdFromToken();
|
|
if (is_null($teamId)) {
|
|
return invalidTokenResponse();
|
|
}
|
|
$server = ModelsServer::whereTeamId($teamId)->whereUuid(request()->uuid)->first();
|
|
if (is_null($server)) {
|
|
return response()->json(['message' => 'Server not found.'], 404);
|
|
}
|
|
$server['resources'] = $server->definedResources()->map(function ($resource) {
|
|
$payload = [
|
|
'id' => $resource->id,
|
|
'uuid' => $resource->uuid,
|
|
'name' => $resource->name,
|
|
'type' => $resource->type(),
|
|
'created_at' => $resource->created_at,
|
|
'updated_at' => $resource->updated_at,
|
|
];
|
|
$payload['status'] = $resource->status;
|
|
|
|
return $payload;
|
|
});
|
|
$server = $this->removeSensitiveData($server);
|
|
|
|
return response()->json(serializeApiResponse(data_get($server, 'resources')));
|
|
}
|
|
|
|
#[OA\Get(
|
|
summary: 'Domains',
|
|
description: 'Get domains by server.',
|
|
path: '/servers/{uuid}/domains',
|
|
operationId: 'get-domains-by-server-uuid',
|
|
security: [
|
|
['bearerAuth' => []],
|
|
],
|
|
tags: ['Servers'],
|
|
parameters: [
|
|
new OA\Parameter(name: 'uuid', in: 'path', required: true, description: 'Server\'s UUID', schema: new OA\Schema(type: 'string')),
|
|
],
|
|
responses: [
|
|
new OA\Response(
|
|
response: 200,
|
|
description: 'Get domains by server',
|
|
content: [
|
|
new OA\MediaType(
|
|
mediaType: 'application/json',
|
|
schema: new OA\Schema(
|
|
type: 'array',
|
|
items: new OA\Items(
|
|
type: 'object',
|
|
properties: [
|
|
'ip' => ['type' => 'string'],
|
|
'domains' => ['type' => 'array', 'items' => ['type' => 'string']],
|
|
]
|
|
)
|
|
)),
|
|
]),
|
|
new OA\Response(
|
|
response: 401,
|
|
ref: '#/components/responses/401',
|
|
),
|
|
new OA\Response(
|
|
response: 400,
|
|
ref: '#/components/responses/400',
|
|
),
|
|
]
|
|
)]
|
|
public function domains_by_server(Request $request)
|
|
{
|
|
$teamId = getTeamIdFromToken();
|
|
if (is_null($teamId)) {
|
|
return invalidTokenResponse();
|
|
}
|
|
$server = ModelsServer::whereTeamId($teamId)->whereUuid($request->uuid)->first();
|
|
if (is_null($server)) {
|
|
return response()->json(['message' => 'Server not found.'], 404);
|
|
}
|
|
$uuid = $request->query('uuid');
|
|
if ($uuid) {
|
|
$application = Application::ownedByCurrentTeamAPI($teamId)->where('uuid', $uuid)->first();
|
|
if (! $application) {
|
|
return response()->json(['message' => 'Application not found.'], 404);
|
|
}
|
|
|
|
return response()->json(serializeApiResponse($application->fqdns));
|
|
}
|
|
$projects = Project::where('team_id', $teamId)->get();
|
|
$domains = collect();
|
|
$applications = $projects->pluck('applications')->flatten()->filter(function ($application) use ($server) {
|
|
return $application->destination?->server?->id === $server->id;
|
|
});
|
|
$settings = instanceSettings();
|
|
if ($applications->count() > 0) {
|
|
foreach ($applications as $application) {
|
|
$ip = $application->destination->server->ip;
|
|
$fqdn = str($application->fqdn)->explode(',')->map(function ($fqdn) {
|
|
$f = str($fqdn)->replace('http://', '')->replace('https://', '')->explode('/');
|
|
|
|
return str(str($f[0])->explode(':')[0]);
|
|
})->filter(function (Stringable $fqdn) {
|
|
return $fqdn->isNotEmpty();
|
|
});
|
|
|
|
if ($ip === 'host.docker.internal') {
|
|
if ($settings->public_ipv4) {
|
|
$domains->push([
|
|
'domain' => $fqdn,
|
|
'ip' => $settings->public_ipv4,
|
|
]);
|
|
}
|
|
if ($settings->public_ipv6) {
|
|
$domains->push([
|
|
'domain' => $fqdn,
|
|
'ip' => $settings->public_ipv6,
|
|
]);
|
|
}
|
|
if (! $settings->public_ipv4 && ! $settings->public_ipv6) {
|
|
$domains->push([
|
|
'domain' => $fqdn,
|
|
'ip' => $ip,
|
|
]);
|
|
}
|
|
} else {
|
|
$domains->push([
|
|
'domain' => $fqdn,
|
|
'ip' => $ip,
|
|
]);
|
|
}
|
|
}
|
|
}
|
|
$services = $projects->pluck('services')->flatten()->filter(function ($service) use ($server) {
|
|
return $service->server_id === $server->id;
|
|
});
|
|
if ($services->count() > 0) {
|
|
foreach ($services as $service) {
|
|
$service_applications = $service->applications;
|
|
if ($service_applications->count() > 0) {
|
|
foreach ($service_applications as $application) {
|
|
$fqdn = str($application->fqdn)->explode(',')->map(function ($fqdn) {
|
|
$f = str($fqdn)->replace('http://', '')->replace('https://', '')->explode('/');
|
|
|
|
return str(str($f[0])->explode(':')[0]);
|
|
})->filter(function (Stringable $fqdn) {
|
|
return $fqdn->isNotEmpty();
|
|
});
|
|
$serviceIp = $server->ip;
|
|
if ($serviceIp === 'host.docker.internal') {
|
|
if ($settings->public_ipv4) {
|
|
$domains->push([
|
|
'domain' => $fqdn,
|
|
'ip' => $settings->public_ipv4,
|
|
]);
|
|
}
|
|
if ($settings->public_ipv6) {
|
|
$domains->push([
|
|
'domain' => $fqdn,
|
|
'ip' => $settings->public_ipv6,
|
|
]);
|
|
}
|
|
if (! $settings->public_ipv4 && ! $settings->public_ipv6) {
|
|
$domains->push([
|
|
'domain' => $fqdn,
|
|
'ip' => $serviceIp,
|
|
]);
|
|
}
|
|
} else {
|
|
$domains->push([
|
|
'domain' => $fqdn,
|
|
'ip' => $serviceIp,
|
|
]);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
$domains = $domains->groupBy('ip')->map(function ($domain) {
|
|
return $domain->pluck('domain')->flatten();
|
|
})->map(function ($domain, $ip) {
|
|
return [
|
|
'ip' => $ip,
|
|
'domains' => $domain,
|
|
];
|
|
})->values();
|
|
|
|
return response()->json(serializeApiResponse($domains));
|
|
}
|
|
|
|
#[OA\Post(
|
|
summary: 'Create',
|
|
description: 'Create Server.',
|
|
path: '/servers',
|
|
operationId: 'create-server',
|
|
security: [
|
|
['bearerAuth' => []],
|
|
],
|
|
tags: ['Servers'],
|
|
requestBody: new OA\RequestBody(
|
|
required: true,
|
|
description: 'Server created.',
|
|
content: new OA\MediaType(
|
|
mediaType: 'application/json',
|
|
schema: new OA\Schema(
|
|
type: 'object',
|
|
properties: [
|
|
'name' => ['type' => 'string', 'example' => 'My Server', 'description' => 'The name of the server.'],
|
|
'description' => ['type' => 'string', 'example' => 'My Server Description', 'description' => 'The description of the server.'],
|
|
'ip' => ['type' => 'string', 'example' => '127.0.0.1', 'description' => 'The IP of the server.'],
|
|
'port' => ['type' => 'integer', 'example' => 22, 'description' => 'The port of the server.'],
|
|
'user' => ['type' => 'string', 'example' => 'root', 'description' => 'The user of the server.'],
|
|
'private_key_uuid' => ['type' => 'string', 'example' => 'og888os', 'description' => 'The UUID of the private key.'],
|
|
'server_role' => ['type' => 'string', 'enum' => ['deployment', 'build', 'both'], 'example' => 'both', 'description' => 'Server role.'],
|
|
'instant_validate' => ['type' => 'boolean', 'example' => false, 'description' => 'Instant validate.'],
|
|
'proxy_type' => ['type' => 'string', 'enum' => ['traefik', 'caddy', 'none'], 'example' => 'traefik', 'description' => 'The proxy type.'],
|
|
],
|
|
),
|
|
),
|
|
),
|
|
responses: [
|
|
new OA\Response(
|
|
response: 201,
|
|
description: 'Server created.',
|
|
content: [
|
|
new OA\MediaType(
|
|
mediaType: 'application/json',
|
|
schema: new OA\Schema(
|
|
type: 'object',
|
|
properties: [
|
|
'uuid' => ['type' => 'string', 'example' => 'og888os', 'description' => 'The UUID of the server.'],
|
|
]
|
|
)
|
|
),
|
|
]),
|
|
new OA\Response(
|
|
response: 401,
|
|
ref: '#/components/responses/401',
|
|
),
|
|
new OA\Response(
|
|
response: 400,
|
|
ref: '#/components/responses/400',
|
|
),
|
|
new OA\Response(
|
|
response: 404,
|
|
ref: '#/components/responses/404',
|
|
),
|
|
new OA\Response(
|
|
response: 422,
|
|
ref: '#/components/responses/422',
|
|
),
|
|
]
|
|
)]
|
|
public function create_server(Request $request)
|
|
{
|
|
$allowedFields = ['name', 'description', 'ip', 'port', 'user', 'private_key_uuid', 'server_role', 'instant_validate', 'proxy_type'];
|
|
|
|
$teamId = getTeamIdFromToken();
|
|
if (is_null($teamId)) {
|
|
return invalidTokenResponse();
|
|
}
|
|
$this->authorize('create', [ModelsServer::class]);
|
|
|
|
$return = validateIncomingRequest($request);
|
|
if ($return instanceof JsonResponse) {
|
|
return $return;
|
|
}
|
|
$validator = customApiValidator($request->all(), [
|
|
'name' => 'string|max:255',
|
|
'description' => 'string|nullable',
|
|
'ip' => ['string', 'required', new ValidServerIp],
|
|
'port' => 'integer|nullable|between:1,65535',
|
|
'private_key_uuid' => 'string|required',
|
|
'user' => ValidationPatterns::serverUsernameRules(required: false),
|
|
'server_role' => 'string|nullable|in:deployment,build,both',
|
|
'instant_validate' => 'boolean|nullable',
|
|
'proxy_type' => 'string|nullable',
|
|
], [
|
|
...ValidationPatterns::serverUsernameMessages(),
|
|
]);
|
|
|
|
$extraFields = array_diff(array_keys($request->all()), $allowedFields);
|
|
if ($validator->fails() || ! empty($extraFields)) {
|
|
$errors = $validator->errors();
|
|
if (! empty($extraFields)) {
|
|
foreach ($extraFields as $field) {
|
|
$errors->add($field, 'This field is not allowed.');
|
|
}
|
|
}
|
|
|
|
return response()->json([
|
|
'message' => 'Validation failed.',
|
|
'errors' => $errors,
|
|
], 422);
|
|
}
|
|
if (! $request->name) {
|
|
$request->offsetSet('name', generate_random_name());
|
|
}
|
|
if (! $request->user) {
|
|
$request->offsetSet('user', 'root');
|
|
}
|
|
if (is_null($request->port)) {
|
|
$request->offsetSet('port', 22);
|
|
}
|
|
$serverRole = $request->filled('server_role')
|
|
? ServerRole::from($request->string('server_role')->toString())
|
|
: ServerRole::BOTH;
|
|
|
|
if ($serverRole === ServerRole::DEPLOYMENT && ! ModelsServer::buildServers($teamId)->exists()) {
|
|
return response()->json([
|
|
'message' => 'Validation failed.',
|
|
'errors' => ['server_role' => ['Add a usable build server before you set this server to deployments only.']],
|
|
], 422);
|
|
}
|
|
if (is_null($request->instant_validate)) {
|
|
$request->offsetSet('instant_validate', false);
|
|
}
|
|
if ($request->proxy_type) {
|
|
$validProxyTypes = collect(ProxyTypes::cases())->map(function ($proxyType) {
|
|
return str($proxyType->value)->lower();
|
|
});
|
|
if (! $validProxyTypes->contains(str($request->proxy_type)->lower())) {
|
|
return response()->json(['message' => 'Invalid proxy type.'], 422);
|
|
}
|
|
}
|
|
$privateKey = PrivateKey::whereTeamId($teamId)->whereUuid($request->private_key_uuid)->first();
|
|
if (! $privateKey) {
|
|
return response()->json(['message' => 'Private key not found.'], 404);
|
|
}
|
|
$foundServer = ModelsServer::whereIp($request->ip)->first();
|
|
if ($foundServer) {
|
|
return response()->json(['message' => 'A server with this IP/Domain is already in use.'], 400);
|
|
}
|
|
|
|
$proxyType = $request->proxy_type ? str($request->proxy_type)->upper() : ProxyTypes::TRAEFIK->value;
|
|
|
|
try {
|
|
$server = Team::createServerWithinLimit($teamId, [
|
|
'name' => $request->name,
|
|
'description' => $request->description,
|
|
'ip' => $request->ip,
|
|
'port' => $request->port,
|
|
'user' => $request->user,
|
|
'private_key_id' => $privateKey->id,
|
|
'team_id' => $teamId,
|
|
]);
|
|
} catch (ValidationException) {
|
|
return response()->json(['message' => 'Server limit reached for your subscription.'], 400);
|
|
}
|
|
$server->proxy->set('type', $proxyType);
|
|
$server->proxy->set('status', ProxyStatus::EXITED->value);
|
|
$server->save();
|
|
|
|
$server->settings()->update([
|
|
'server_role' => $serverRole,
|
|
'is_build_server' => $serverRole === ServerRole::BUILD,
|
|
]);
|
|
if ($request->instant_validate) {
|
|
ValidateServer::dispatch($server);
|
|
}
|
|
|
|
auditLog('api.server.created', [
|
|
'team_id' => $teamId,
|
|
'server_uuid' => $server->uuid,
|
|
'server_name' => $server->name,
|
|
'ip' => $server->ip,
|
|
'server_role' => $serverRole->value,
|
|
]);
|
|
|
|
return response()->json([
|
|
'uuid' => $server->uuid,
|
|
])->setStatusCode(201);
|
|
}
|
|
|
|
#[OA\Patch(
|
|
summary: 'Update',
|
|
description: 'Update Server.',
|
|
path: '/servers/{uuid}',
|
|
operationId: 'update-server-by-uuid',
|
|
security: [
|
|
['bearerAuth' => []],
|
|
],
|
|
tags: ['Servers'],
|
|
parameters: [
|
|
new OA\Parameter(name: 'uuid', in: 'path', required: true, description: 'Server UUID', schema: new OA\Schema(type: 'string')),
|
|
],
|
|
requestBody: new OA\RequestBody(
|
|
required: true,
|
|
description: 'Server updated.',
|
|
content: new OA\MediaType(
|
|
mediaType: 'application/json',
|
|
schema: new OA\Schema(
|
|
type: 'object',
|
|
properties: [
|
|
'name' => ['type' => 'string', 'description' => 'The name of the server.'],
|
|
'description' => ['type' => 'string', 'description' => 'The description of the server.'],
|
|
'ip' => ['type' => 'string', 'description' => 'The IP of the server.'],
|
|
'port' => ['type' => 'integer', 'description' => 'The port of the server.'],
|
|
'user' => ['type' => 'string', 'description' => 'The user of the server.'],
|
|
'private_key_uuid' => ['type' => 'string', 'description' => 'The UUID of the private key.'],
|
|
'server_role' => ['type' => 'string', 'enum' => ['deployment', 'build', 'both'], 'description' => 'Server role.'],
|
|
'instant_validate' => ['type' => 'boolean', 'description' => 'Instant validate.'],
|
|
'proxy_type' => ['type' => 'string', 'enum' => ['traefik', 'caddy', 'none'], 'description' => 'The proxy type.'],
|
|
'concurrent_builds' => ['type' => 'integer', 'description' => 'Number of concurrent builds.'],
|
|
'dynamic_timeout' => ['type' => 'integer', 'description' => 'Deployment timeout in seconds.'],
|
|
'deployment_queue_limit' => ['type' => 'integer', 'description' => 'Maximum number of queued deployments.'],
|
|
'server_disk_usage_notification_threshold' => ['type' => 'integer', 'description' => 'Server disk usage notification threshold (%).'],
|
|
'server_disk_usage_check_frequency' => ['type' => 'string', 'description' => 'Cron expression for disk usage check frequency.'],
|
|
'connection_timeout' => ['type' => 'integer', 'description' => 'SSH connection timeout in seconds (1-300). Default: 10.'],
|
|
],
|
|
),
|
|
),
|
|
),
|
|
responses: [
|
|
new OA\Response(
|
|
response: 201,
|
|
description: 'Server updated.',
|
|
content: [
|
|
new OA\MediaType(
|
|
mediaType: 'application/json',
|
|
schema: new OA\Schema(
|
|
ref: '#/components/schemas/Server'
|
|
)
|
|
),
|
|
]),
|
|
new OA\Response(
|
|
response: 401,
|
|
ref: '#/components/responses/401',
|
|
),
|
|
new OA\Response(
|
|
response: 400,
|
|
ref: '#/components/responses/400',
|
|
),
|
|
new OA\Response(
|
|
response: 404,
|
|
ref: '#/components/responses/404',
|
|
),
|
|
new OA\Response(
|
|
response: 422,
|
|
ref: '#/components/responses/422',
|
|
),
|
|
]
|
|
)]
|
|
public function update_server(Request $request)
|
|
{
|
|
$allowedFields = ['name', 'description', 'ip', 'port', 'user', 'private_key_uuid', 'server_role', 'instant_validate', 'proxy_type', 'concurrent_builds', 'dynamic_timeout', 'deployment_queue_limit', 'server_disk_usage_notification_threshold', 'server_disk_usage_check_frequency', 'connection_timeout', 'is_terminal_enabled'];
|
|
|
|
$teamId = getTeamIdFromToken();
|
|
if (is_null($teamId)) {
|
|
return invalidTokenResponse();
|
|
}
|
|
|
|
$return = validateIncomingRequest($request);
|
|
if ($return instanceof JsonResponse) {
|
|
return $return;
|
|
}
|
|
$validator = customApiValidator($request->all(), [
|
|
'name' => 'string|max:255|nullable',
|
|
'description' => 'string|nullable',
|
|
'ip' => ['string', 'nullable', new ValidServerIp],
|
|
'port' => 'integer|nullable|between:1,65535',
|
|
'private_key_uuid' => 'string|nullable',
|
|
'user' => ValidationPatterns::serverUsernameRules(required: false),
|
|
'server_role' => 'string|nullable|in:deployment,build,both',
|
|
'instant_validate' => 'boolean|nullable',
|
|
'proxy_type' => 'string|nullable',
|
|
'concurrent_builds' => 'integer|min:1',
|
|
'dynamic_timeout' => 'integer|min:1',
|
|
'deployment_queue_limit' => 'integer|min:1',
|
|
'server_disk_usage_notification_threshold' => 'integer|min:1|max:100',
|
|
'server_disk_usage_check_frequency' => 'string',
|
|
'connection_timeout' => 'integer|min:1|max:300',
|
|
'is_terminal_enabled' => 'boolean|nullable',
|
|
], [
|
|
...ValidationPatterns::serverUsernameMessages(),
|
|
]);
|
|
|
|
$extraFields = array_diff(array_keys($request->all()), $allowedFields);
|
|
if ($validator->fails() || ! empty($extraFields)) {
|
|
$errors = $validator->errors();
|
|
if (! empty($extraFields)) {
|
|
foreach ($extraFields as $field) {
|
|
$errors->add($field, 'This field is not allowed.');
|
|
}
|
|
}
|
|
|
|
return response()->json([
|
|
'message' => 'Validation failed.',
|
|
'errors' => $errors,
|
|
], 422);
|
|
}
|
|
$server = ModelsServer::whereTeamId($teamId)->whereUuid($request->uuid)->first();
|
|
if (! $server) {
|
|
return response()->json(['message' => 'Server not found.'], 404);
|
|
}
|
|
$this->authorize('update', $server);
|
|
if ($request->proxy_type) {
|
|
$validProxyTypes = collect(ProxyTypes::cases())->map(function ($proxyType) {
|
|
return str($proxyType->value)->lower();
|
|
});
|
|
if (! $validProxyTypes->contains(str($request->proxy_type)->lower())) {
|
|
return response()->json(['message' => 'Invalid proxy type.'], 422);
|
|
}
|
|
}
|
|
$updateFields = $request->only(['name', 'description', 'ip', 'port', 'user']);
|
|
if ($request->filled('private_key_uuid')) {
|
|
$privateKey = PrivateKey::whereTeamId($teamId)->whereUuid($request->private_key_uuid)->first();
|
|
if (! $privateKey) {
|
|
return response()->json(['message' => 'Private key not found.'], 404);
|
|
}
|
|
$updateFields['private_key_id'] = $privateKey->id;
|
|
}
|
|
|
|
if ($request->has('server_disk_usage_check_frequency') && ! validate_cron_expression($request->server_disk_usage_check_frequency)) {
|
|
return response()->json([
|
|
'message' => 'Validation failed.',
|
|
'errors' => ['server_disk_usage_check_frequency' => ['Invalid Cron / Human expression for Disk Usage Check Frequency.']],
|
|
], 422);
|
|
}
|
|
|
|
$serverRole = null;
|
|
if ($request->filled('server_role')) {
|
|
$serverRole = ServerRole::from($request->string('server_role')->toString());
|
|
}
|
|
|
|
if ($serverRole === ServerRole::BUILD && ! $server->isBuildServer() && ! $server->isEmpty()) {
|
|
return response()->json([
|
|
'message' => 'Validation failed.',
|
|
'errors' => ['server_role' => ['A server with existing resources cannot be configured as build only.']],
|
|
], 422);
|
|
}
|
|
|
|
if ($serverRole === ServerRole::DEPLOYMENT && ! ModelsServer::buildServers($teamId)->whereKeyNot($server->id)->exists()) {
|
|
return response()->json([
|
|
'message' => 'Validation failed.',
|
|
'errors' => ['server_role' => ['Add a usable build server before you set this server to deployments only.']],
|
|
], 422);
|
|
}
|
|
|
|
$server->update($updateFields);
|
|
if ($serverRole !== null) {
|
|
$server->settings()->update([
|
|
'server_role' => $serverRole,
|
|
'is_build_server' => $serverRole === ServerRole::BUILD,
|
|
]);
|
|
}
|
|
|
|
if ($request->has('is_terminal_enabled')) {
|
|
$server->settings()->update([
|
|
'is_terminal_enabled' => $request->boolean('is_terminal_enabled'),
|
|
]);
|
|
}
|
|
|
|
$advancedSettings = $request->only(['concurrent_builds', 'dynamic_timeout', 'deployment_queue_limit', 'server_disk_usage_notification_threshold', 'server_disk_usage_check_frequency', 'connection_timeout']);
|
|
if (! empty($advancedSettings)) {
|
|
$server->settings()->update(array_filter($advancedSettings, fn ($value) => ! is_null($value)));
|
|
}
|
|
|
|
if ($request->proxy_type) {
|
|
$server->changeProxy($request->proxy_type, async: true);
|
|
}
|
|
|
|
if ($request->instant_validate) {
|
|
ValidateServer::dispatch($server);
|
|
}
|
|
|
|
auditLog('api.server.updated', [
|
|
'team_id' => $teamId,
|
|
'server_uuid' => $server->uuid,
|
|
'server_name' => $server->name,
|
|
'changed_fields' => array_values(array_intersect($allowedFields, array_keys($request->all()))),
|
|
]);
|
|
|
|
return response()->json([
|
|
'uuid' => $server->uuid,
|
|
])->setStatusCode(201);
|
|
}
|
|
|
|
#[OA\Delete(
|
|
summary: 'Delete',
|
|
description: 'Delete server by UUID.',
|
|
path: '/servers/{uuid}',
|
|
operationId: 'delete-server-by-uuid',
|
|
security: [
|
|
['bearerAuth' => []],
|
|
],
|
|
tags: ['Servers'],
|
|
parameters: [
|
|
new OA\Parameter(
|
|
name: 'uuid',
|
|
in: 'path',
|
|
description: 'UUID of the server.',
|
|
required: true,
|
|
schema: new OA\Schema(
|
|
type: 'string',
|
|
)
|
|
),
|
|
],
|
|
responses: [
|
|
new OA\Response(
|
|
response: 200,
|
|
description: 'Server deleted.',
|
|
content: [
|
|
new OA\MediaType(
|
|
mediaType: 'application/json',
|
|
schema: new OA\Schema(
|
|
type: 'object',
|
|
properties: [
|
|
'message' => ['type' => 'string', 'example' => 'Server deleted.'],
|
|
]
|
|
)
|
|
),
|
|
]),
|
|
new OA\Response(
|
|
response: 401,
|
|
ref: '#/components/responses/401',
|
|
),
|
|
new OA\Response(
|
|
response: 400,
|
|
ref: '#/components/responses/400',
|
|
),
|
|
new OA\Response(
|
|
response: 404,
|
|
ref: '#/components/responses/404',
|
|
),
|
|
new OA\Response(
|
|
response: 422,
|
|
ref: '#/components/responses/422',
|
|
),
|
|
]
|
|
)]
|
|
public function delete_server(Request $request)
|
|
{
|
|
$teamId = getTeamIdFromToken();
|
|
if (is_null($teamId)) {
|
|
return invalidTokenResponse();
|
|
}
|
|
|
|
if (! $request->uuid) {
|
|
return response()->json(['message' => 'Uuid is required.'], 422);
|
|
}
|
|
$server = ModelsServer::whereTeamId($teamId)->whereUuid($request->uuid)->first();
|
|
|
|
if (! $server) {
|
|
return response()->json(['message' => 'Server not found.'], 404);
|
|
}
|
|
$this->authorize('delete', $server);
|
|
|
|
$force = filter_var($request->query('force', false), FILTER_VALIDATE_BOOLEAN);
|
|
|
|
if ($server->definedResources()->count() > 0 && ! $force) {
|
|
return response()->json(['message' => 'Server has resources. Use ?force=true to delete all resources and the server, or delete resources manually first.'], 400);
|
|
}
|
|
if ($server->is_coolify_host) {
|
|
return response()->json(['message' => 'Local server cannot be deleted.'], 400);
|
|
}
|
|
|
|
if ($force) {
|
|
foreach ($server->definedResources() as $resource) {
|
|
DeleteResourceJob::dispatch($resource);
|
|
}
|
|
}
|
|
|
|
$deletedUuid = $server->uuid;
|
|
$deletedName = $server->name;
|
|
$deletedIp = $server->ip;
|
|
$server->delete();
|
|
DeleteServer::dispatch(
|
|
$server->id,
|
|
false, // Don't delete from Hetzner via API
|
|
$server->hetzner_server_id,
|
|
$server->cloud_provider_token_id,
|
|
$server->team_id,
|
|
false, // Don't delete from Vultr via API
|
|
$server->vultr_instance_id,
|
|
false, // Don't delete from DigitalOcean via API
|
|
$server->digitalocean_droplet_id
|
|
);
|
|
|
|
auditLog('api.server.deleted', [
|
|
'team_id' => $teamId,
|
|
'server_uuid' => $deletedUuid,
|
|
'server_name' => $deletedName,
|
|
'ip' => $deletedIp,
|
|
'force' => $force,
|
|
]);
|
|
|
|
return response()->json(['message' => 'Server deleted.']);
|
|
}
|
|
|
|
#[OA\Post(
|
|
summary: 'Validate',
|
|
description: 'Validate server by UUID.',
|
|
path: '/servers/{uuid}/validate',
|
|
operationId: 'validate-server-by-uuid',
|
|
security: [
|
|
['bearerAuth' => []],
|
|
],
|
|
tags: ['Servers'],
|
|
parameters: [
|
|
new OA\Parameter(name: 'uuid', in: 'path', required: true, description: 'Server UUID', schema: new OA\Schema(type: 'string')),
|
|
],
|
|
requestBody: new OA\RequestBody(
|
|
required: false,
|
|
content: new OA\JsonContent(
|
|
properties: [
|
|
new OA\Property(
|
|
property: 'install',
|
|
description: 'Install missing prerequisites and Docker. This can restart the Docker daemon.',
|
|
type: 'boolean',
|
|
default: false,
|
|
),
|
|
],
|
|
),
|
|
),
|
|
responses: [
|
|
new OA\Response(
|
|
response: 201,
|
|
description: 'Server validation started.',
|
|
content: [
|
|
new OA\MediaType(
|
|
mediaType: 'application/json',
|
|
schema: new OA\Schema(
|
|
type: 'object',
|
|
properties: [
|
|
'message' => ['type' => 'string', 'example' => 'Validation started.'],
|
|
]
|
|
)
|
|
),
|
|
]),
|
|
new OA\Response(
|
|
response: 401,
|
|
ref: '#/components/responses/401',
|
|
),
|
|
new OA\Response(
|
|
response: 400,
|
|
ref: '#/components/responses/400',
|
|
),
|
|
new OA\Response(
|
|
response: 404,
|
|
ref: '#/components/responses/404',
|
|
),
|
|
new OA\Response(
|
|
response: 422,
|
|
ref: '#/components/responses/422',
|
|
),
|
|
]
|
|
)]
|
|
public function validate_server(Request $request)
|
|
{
|
|
$teamId = getTeamIdFromToken();
|
|
if (is_null($teamId)) {
|
|
return invalidTokenResponse();
|
|
}
|
|
|
|
if (! $request->uuid) {
|
|
return response()->json(['message' => 'Uuid is required.'], 422);
|
|
}
|
|
$server = ModelsServer::whereTeamId($teamId)->whereUuid($request->uuid)->first();
|
|
|
|
if (! $server) {
|
|
return response()->json(['message' => 'Server not found.'], 404);
|
|
}
|
|
$this->authorize('update', $server);
|
|
|
|
if (! $server->canBeValidated()) {
|
|
return response()->json([
|
|
'message' => 'This server was transferred to another Coolify instance and cannot be revalidated here.',
|
|
], 422);
|
|
}
|
|
|
|
$validator = customApiValidator($request->all(), [
|
|
'install' => 'boolean',
|
|
]);
|
|
if ($validator->fails()) {
|
|
return response()->json([
|
|
'message' => 'Validation failed.',
|
|
'errors' => $validator->errors(),
|
|
], 422);
|
|
}
|
|
|
|
$install = $request->boolean('install', false);
|
|
if ($install) {
|
|
ValidateAndInstallServerJob::dispatch($server);
|
|
} else {
|
|
ValidateServer::dispatch($server);
|
|
}
|
|
|
|
auditLog('api.server.validated', [
|
|
'team_id' => $teamId,
|
|
'server_uuid' => $server->uuid,
|
|
'server_name' => $server->name,
|
|
'install' => $install,
|
|
]);
|
|
|
|
$message = $install ? 'Validation and installation started.' : 'Validation started.';
|
|
|
|
return response()->json(['message' => $message], 201);
|
|
}
|
|
}
|