Modern Docker Management, Designed for Everyone
Go composecontainer-managementcontainersdockerdocker-composedocker-managementgoself-hostedsveltekittypescriptweb-ui
import { environmentStore } from '#lib/stores/environment.store.svelte.js';
import userStore from '#lib/stores/user-store.svelte.js';
import type { Settings, OidcStatusInfo } from '#lib/types/settings.js';
import { isLocalSetting, extractLocalSettings, extractEnvironmentSettings } from '#lib/utils/settings.svelte.js';
import BaseAPIService from './api-service';
type KeyValuePair = { key: string; value: string };
class SettingsService extends BaseAPIService {
async getSettings(): Promise<Settings> {
// Wait for environment store to be initialized before fetching settings
await environmentStore.ready;
const envId = await environmentStore.getCurrentEnvironmentId();
return this.getSettingsForEnvironmentMerged(envId);
}
async getSettingsForEnvironmentMerged(environmentId: string): Promise<Settings> {
// If we're on environment 0, just get all settings normally
if (environmentId === '0') {
const res = await this.api.get(`/environments/0/settings`);
return this.normalize(res.data);
}
// For remote environments, merge:
// - UI settings from environment 0 (main instance)
// - Environment-specific settings from current environment
const [mainSettings, envSettings] = await Promise.all([
this.api.get(
userStore.hasPermission('settings:read', '0') ? '/environments/0/settings' : '/environments/0/settings/public'
),
this.api.get(`/environments/${environmentId}/settings`)
]);
const mainNormalized = this.normalize(mainSettings.data);
const envNormalized = this.normalize(envSettings.data);
// Extract UI settings from main, environment settings from current env
const uiSettings = extractLocalSettings(mainNormalized);
const operationalSettings = extractEnvironmentSettings(envNormalized);
// Merge them
return { ...operationalSettings, ...uiSettings } as Settings;
}
async getSettingsForEnvironment(environmentId: string): Promise<Settings> {
// When viewing a specific environment's settings page, show all its settings
const res = await this.api.get(`/environments/${environmentId}/settings`);
return this.normalize(res.data);
}
async getPublicSettingsForEnvironment(environmentId: string, signal?: AbortSignal): Promise<Settings> {
const res = await this.api.get(`/environments/${environmentId}/settings/public`, { signal });
return this.normalize(res.data);
}
async getPublicSettings(environmentId = '0'): Promise<Settings> {
if (environmentId === '0') return this.getPublicSettingsForEnvironment('0');
const [mainSettings, environmentSettings] = await Promise.all([
this.getPublicSettingsForEnvironment('0'),
this.getPublicSettingsForEnvironment(environmentId)
]);
return { ...extractEnvironmentSettings(environmentSettings), ...extractLocalSettings(mainSettings) } as Settings;
}
/** The environment's merged settings, or only its public settings without `settings:read`. */
async getReadableSettings(environmentId: string): Promise<Settings> {
if (!userStore.hasPermission('settings:read', environmentId)) return this.getPublicSettings(environmentId);
return this.getSettingsForEnvironmentMerged(environmentId);
}
async updateSettings(settings: Partial<Settings>) {
// Wait for environment store to be initialized before updating settings
await environmentStore.ready;
const envId = await environmentStore.getCurrentEnvironmentId();
return this.updateSettingsForEnvironment(envId, settings);
}
async updateSettingsForEnvironment(envId: string, settings: Partial<Settings>) {
const uiSettings: Record<string, any> = {};
const envSettings: Record<string, any> = {};
// Separate UI settings from environment settings
for (const key in settings) {
if (isLocalSetting(key)) {
uiSettings[key] = settings[key as keyof Settings];
} else {
envSettings[key] = settings[key as keyof Settings];
}
}
// Update UI settings on environment 0 (main instance)
if (Object.keys(uiSettings).length > 0) {
const payload: Record<string, string> = {};
for (const key in uiSettings) {
const v = uiSettings[key];
payload[key] = typeof v === 'object' && v !== null ? JSON.stringify(v) : String(v);
}
await this.api.put('/environments/0/settings', payload);
}
// Update environment settings on target environment
if (Object.keys(envSettings).length > 0) {
const payload: Record<string, string> = {};
for (const key in envSettings) {
const v = envSettings[key];
payload[key] = typeof v === 'object' && v !== null ? JSON.stringify(v) : String(v);
}
await this.api.put(`/environments/${envId}/settings`, payload);
}
// Reload and return merged settings
return this.getReadableSettings(envId);
}
async getOidcStatus(): Promise<OidcStatusInfo> {
return this.handleResponse(this.api.get('/oidc/status'));
}
private normalize(data: any): Settings {
if (data && !Array.isArray(data) && !Array.isArray(data?.settings)) {
return data as Settings;
}
let list: KeyValuePair[] = [];
if (Array.isArray(data)) list = data;
else if (Array.isArray(data?.settings)) list = data.settings;
const settings: Record<string, unknown> = {};
list.forEach(({ key, value }) => {
settings[key] = this.parseValue(key, value);
});
return settings as Settings;
}
private parseValue(key: string, value: string) {
if (key === 'registryCredentials' || key === 'templateRegistries') {
try {
return JSON.parse(value);
} catch {
return [];
}
}
if (value === 'true') return true;
if (value === 'false') return false;
if (key === 'projectWorkspaceMaxFileSizeMb' || key === 'volumeWorkspaceMaxFileSizeMb' || key === 'upgradeLogRetentionDays') {
return Number(value);
}
return value;
}
}
export const settingsService = new SettingsService();