diff --git a/src/client/components/hoc/StatusProvider/StatusProvider.tsx b/src/client/components/hoc/StatusProvider/StatusProvider.tsx
deleted file mode 100644
index 35f5a4cf..00000000
--- a/src/client/components/hoc/StatusProvider/StatusProvider.tsx
+++ /dev/null
@@ -1,52 +0,0 @@
-'use client';
-
-import React, { useRef, useEffect } from 'react';
-import { SystemStatus, useSystemStore } from '@/client/state/systemStore';
-import { useRouter } from 'next/navigation';
-import useSWR, { Fetcher } from 'swr';
-import { StatusScreen } from '../../StatusScreen';
-
-interface IProps {
- children: React.ReactNode;
-}
-
-const fetcher: Fetcher<{ status?: SystemStatus; success?: boolean }> = () =>
- fetch('/api/get-status', { cache: 'no-store', next: { revalidate: 0 } }).then((res) => res.json() as Promise<{ status: SystemStatus }>);
-
-export const StatusProvider: React.FC = ({ children }) => {
- const { status, setStatus, pollStatus, setPollStatus } = useSystemStore();
- const s = useRef(status);
-
- const router = useRouter();
-
- useSWR('/api/get-status', fetcher, {
- refreshInterval: pollStatus ? 2000 : 0,
- isPaused: () => !pollStatus,
- onSuccess: (res) => {
- if (res.success && res.status) {
- setStatus(res.status);
- }
- },
- });
-
- useEffect(() => {
- // If previous was not running and current is running, we need to refresh the page
- if (status === 'RUNNING' && s.current !== 'RUNNING') {
- setPollStatus(false);
- router.push('/');
- router.refresh();
- }
- if (status === 'RUNNING') {
- s.current = 'RUNNING';
- }
- if (status === 'RESTARTING') {
- s.current = 'RESTARTING';
- }
- }, [status, s, router, setPollStatus]);
-
- if (status === 'RESTARTING') {
- return ;
- }
-
- return children;
-};
diff --git a/src/client/components/hoc/StatusProvider/index.ts b/src/client/components/hoc/StatusProvider/index.ts
deleted file mode 100644
index 8fbca663..00000000
--- a/src/client/components/hoc/StatusProvider/index.ts
+++ /dev/null
@@ -1 +0,0 @@
-export { StatusProvider } from './StatusProvider';
diff --git a/src/client/messages/en-US.json b/src/client/messages/en-US.json
index 0b3d4829..295669fe 100644
--- a/src/client/messages/en-US.json
+++ b/src/client/messages/en-US.json
@@ -107,6 +107,7 @@
},
"apps": {
"status-running": "Running",
+ "status-reseting": "Resetting",
"status-stopped": "Stopped",
"status-starting": "Starting",
"status-stopping": "Stopping",
@@ -135,6 +136,7 @@
"update-success": "App updated successfully",
"start-success": "App started successfully",
"update-config-success": "App config updated successfully. Restart the app to apply the changes",
+ "app-reset-success": "App reset successfully",
"version": "Version",
"description": "Description",
"base-info": "Base info",
@@ -182,6 +184,7 @@
"choose-option": "Choose an option...",
"sumbit-install": "Install",
"submit-update": "Update",
+ "reset": "Reset app",
"errors": {
"required": "{label} is required",
"regex": "{label} does not match the pattern {pattern}",
diff --git a/src/client/messages/en.json b/src/client/messages/en.json
index e5c9bb68..786e8f40 100644
--- a/src/client/messages/en.json
+++ b/src/client/messages/en.json
@@ -108,6 +108,7 @@
"apps": {
"status-running": "Running",
"status-stopped": "Stopped",
+ "status-resetting": "Resetting",
"status-starting": "Starting",
"status-stopping": "Stopping",
"status-updating": "Updating",
@@ -136,6 +137,7 @@
"start-success": "App started successfully",
"update-config-success": "App config updated successfully. Restart the app to apply the changes",
"version": "Version",
+ "app-reset-success": "App reset successfully",
"description": "Description",
"base-info": "Base info",
"source-code": "Source code",
@@ -183,6 +185,7 @@
"choose-option": "Choose an option...",
"sumbit-install": "Install",
"submit-update": "Update",
+ "reset": "Reset app",
"errors": {
"required": "{label} is required",
"regex": "{label} must match the pattern {pattern}",
@@ -208,10 +211,16 @@
"warning": "Are you sure? This action cannot be undone.",
"submit": "Uninstall"
},
+ "reset-app-form": {
+ "title": "Reset {name} ?",
+ "subtitle": "All data for this app will be lost.",
+ "warning": "Are you sure? This action cannot be undone.",
+ "submit": "Reset"
+ },
"update-form": {
"title": "Update {name} ?",
"subtitle1": "Update app to latest verion :",
- "subtitle2": "This will reset your custom configuration (e.g. changes in docker-compose.yml)",
+ "subtitle2": "Make sure you've read the release notes of the app and you've backed up your app data.",
"submit": "Update"
},
"update-settings-form": {
@@ -242,6 +251,8 @@
"invalid-domain": "Invalid domain",
"guest-dashboard": "Enable guest dashboard",
"guest-dashboard-hint": "This will allow non-authenticated users to see a limited dashboard and easily access the running apps on your instance.",
+ "allow-auto-themes": "Allow auto themes",
+ "allow-auto-themes-hint": "Be surprised by themes that change automatically based on the time of the year.",
"domain-name": "Domain name",
"domain-name-hint": "Make sure this exact domain contains an A record pointing to your IP.",
"dns-ip": "DNS IP",
diff --git a/src/client/state/systemStore.ts b/src/client/state/systemStore.ts
index c330b5f9..5a84329e 100644
--- a/src/client/state/systemStore.ts
+++ b/src/client/state/systemStore.ts
@@ -1,17 +1,8 @@
import { create } from 'zustand';
-const SYSTEM_STATUS = {
- RUNNING: 'RUNNING',
- RESTARTING: 'RESTARTING',
- LOADING: 'UPDATING',
-} as const;
-export type SystemStatus = (typeof SYSTEM_STATUS)[keyof typeof SYSTEM_STATUS];
-
type Store = {
- status: SystemStatus;
pollStatus: boolean;
version: { current: string; latest?: string };
- setStatus: (status: SystemStatus) => void;
setVersion: (version: { current: string; latest?: string }) => void;
setPollStatus: (pollStatus: boolean) => void;
};
@@ -20,7 +11,6 @@ export const useSystemStore = create((set) => ({
status: 'RUNNING',
version: { current: '0.0.0', latest: '0.0.0' },
pollStatus: false,
- setStatus: (status: SystemStatus) => set((state) => ({ ...state, status })),
setVersion: (version: { current: string; latest?: string }) => set((state) => ({ ...state, version })),
setPollStatus: (pollStatus: boolean) => set((state) => ({ ...state, pollStatus })),
}));
diff --git a/src/lib/themes.ts b/src/lib/themes.ts
new file mode 100644
index 00000000..5ffe37a3
--- /dev/null
+++ b/src/lib/themes.ts
@@ -0,0 +1,38 @@
+export const THEMES = {
+ christmas: {
+ name: 'christmas',
+ month: 11,
+ day: 1,
+ durationInDays: 26,
+ },
+};
+
+export type Theme = keyof typeof THEMES | 'default';
+
+export const getAutoTheme = (): Theme => {
+ const date = new Date();
+
+ const theme = Object.entries(THEMES).find(([, { month, day, durationInDays }]) => {
+ const startDate = new Date(date.getFullYear(), month, day);
+ const endDate = new Date(date.getFullYear(), month, day + durationInDays);
+
+ return startDate <= date && date <= endDate;
+ });
+
+ return theme ? (theme[0] as Theme) : 'default';
+};
+
+export const getLogo = (autoTheme: boolean) => {
+ if (!autoTheme) {
+ return '/tipi.png';
+ }
+
+ const theme = getAutoTheme();
+
+ switch (theme) {
+ case 'christmas':
+ return '/tipi-christmas.png';
+ default:
+ return '/tipi.png';
+ }
+};
diff --git a/src/server/core/TipiConfig/TipiConfig.ts b/src/server/core/TipiConfig/TipiConfig.ts
index 792385e4..d6a5fbd1 100644
--- a/src/server/core/TipiConfig/TipiConfig.ts
+++ b/src/server/core/TipiConfig/TipiConfig.ts
@@ -1,5 +1,5 @@
import { z } from 'zod';
-import { envSchema, settingsSchema } from '@runtipi/shared';
+import { envSchema, envStringToMap, settingsSchema } from '@runtipi/shared';
import fs from 'fs-extra';
import nextConfig from 'next/config';
import { readJsonFile } from '../../common/fs.helpers';
@@ -19,13 +19,22 @@ export class TipiConfig {
private config: z.infer = {} as z.infer;
constructor() {
- const conf = { ...process.env, ...nextConfig()?.serverRuntimeConfig };
- const envConfig: z.infer = {
+ let envFile = '';
+ try {
+ envFile = fs.readFileSync('/runtipi/.env').toString();
+ } catch (e) {
+ Logger.error('β .env file not found');
+ }
+
+ const envMap = envStringToMap(envFile.toString());
+
+ const conf = { ...process.env, ...Object.fromEntries(envMap), ...nextConfig().serverRuntimeConfig };
+ const envConfig: z.input = {
postgresHost: conf.POSTGRES_HOST,
postgresDatabase: conf.POSTGRES_DBNAME,
postgresUsername: conf.POSTGRES_USERNAME,
postgresPassword: conf.POSTGRES_PASSWORD,
- postgresPort: Number(conf.POSTGRES_PORT || 5432),
+ postgresPort: Number(conf.POSTGRES_PORT),
REDIS_HOST: conf.REDIS_HOST,
redisPassword: conf.REDIS_PASSWORD,
NODE_ENV: conf.NODE_ENV,
@@ -39,11 +48,11 @@ export class TipiConfig {
domain: conf.DOMAIN,
localDomain: conf.LOCAL_DOMAIN,
dnsIp: conf.DNS_IP || '9.9.9.9',
- status: 'RUNNING',
storagePath: conf.STORAGE_PATH,
demoMode: conf.DEMO_MODE,
guestDashboard: conf.GUEST_DASHBOARD,
seePreReleaseVersions: false,
+ allowAutoThemes: true,
};
const parsedConfig = envSchema.safeParse({ ...envConfig, ...this.getFileConfig() });
@@ -76,7 +85,14 @@ export class TipiConfig {
}
public getConfig() {
- return { ...this.config, ...this.getFileConfig() };
+ let conf = { ...this.config, ...this.getFileConfig() };
+
+ // If we are not in test mode, we need to set the postgres port to 5432 (internal port)
+ if (conf.NODE_ENV !== 'test') {
+ conf = { ...conf, postgresPort: 5432 };
+ }
+
+ return conf;
}
public getSettings() {
diff --git a/src/server/run-migrations-dev.ts b/src/server/run-migrations-dev.ts
index ae6646dc..6567221a 100644
--- a/src/server/run-migrations-dev.ts
+++ b/src/server/run-migrations-dev.ts
@@ -17,7 +17,7 @@ export const runPostgresMigrations = async (dbName?: string) => {
host: postgresHost,
database: dbName || postgresDatabase,
password: postgresPassword,
- port: Number(postgresPort),
+ port: Number(process.env.POSTGRES_PORT),
});
await client.connect();
@@ -36,11 +36,11 @@ export const runPostgresMigrations = async (dbName?: string) => {
Logger.info('Running migrations');
try {
- await migrate({ client }, path.join(__dirname, '../../packages/cli/assets/migrations'), { skipCreateMigrationTable: true });
+ await migrate({ client }, path.join(__dirname, '../../packages/worker/assets/migrations'), { skipCreateMigrationTable: true });
} catch (e) {
Logger.error('Error running migrations. Dropping table migrations and trying again');
await client.query('DROP TABLE migrations');
- await migrate({ client }, path.join(__dirname, '../../packages/cli/assets/migrations'), { skipCreateMigrationTable: true });
+ await migrate({ client }, path.join(__dirname, '../../packages/worker/assets/migrations'), { skipCreateMigrationTable: true });
}
Logger.info('Migration complete');
diff --git a/src/server/services/apps/apps.service.test.ts b/src/server/services/apps/apps.service.test.ts
index 5e86d485..87d4da4a 100644
--- a/src/server/services/apps/apps.service.test.ts
+++ b/src/server/services/apps/apps.service.test.ts
@@ -351,6 +351,21 @@ describe('Update app config', () => {
});
});
+describe('Reset app', () => {
+ it('Should correctly reset app', async () => {
+ // arrange
+ const appConfig = createAppConfig({});
+ await insertApp({ status: 'running' }, appConfig, db);
+
+ // act
+ await AppsService.resetApp(appConfig.id);
+ const app = await getAppById(appConfig.id, db);
+
+ // assert
+ expect(app?.status).toBe('running');
+ });
+});
+
describe('Get app config', () => {
it('Should correctly get app config', async () => {
// arrange
@@ -462,7 +477,7 @@ describe('Update app', () => {
it('Should correctly update app', async () => {
// arrange
const appConfig = createAppConfig({});
- await insertApp({ version: 12, config: { TEST_FIELD: 'test' } }, appConfig, db);
+ await insertApp({ version: 12, status: 'running', config: { TEST_FIELD: 'test' } }, appConfig, db);
// act
await updateApp(appConfig.id, { version: 0 }, db);
@@ -472,7 +487,7 @@ describe('Update app', () => {
expect(app).toBeDefined();
expect(app?.config).toStrictEqual({ TEST_FIELD: 'test' });
expect(app?.version).toBe(appConfig.tipi_version);
- expect(app?.status).toBe('stopped');
+ expect(app?.status).toBe('running');
});
it("Should throw if app doesn't exist", async () => {
@@ -490,6 +505,16 @@ describe('Update app', () => {
const app = await getAppById(appConfig.id, db);
expect(app?.status).toBe('stopped');
});
+ it('Should comme back to the previous status before the update of the app', async () => {
+ // arrange
+ const appConfig = createAppConfig({});
+ await insertApp({ status: 'stopped' }, appConfig, db);
+
+ // act & assert
+ await updateApp(appConfig.id, { version: 0 }, db);
+ const app = await getAppById(appConfig.id, db);
+ expect(app?.status).toBe('stopped');
+ });
});
describe('installedApps', () => {
diff --git a/src/server/services/apps/apps.service.ts b/src/server/services/apps/apps.service.ts
index 62e741b8..be0da68e 100644
--- a/src/server/services/apps/apps.service.ts
+++ b/src/server/services/apps/apps.service.ts
@@ -341,6 +341,7 @@ export class AppServiceClass {
*/
public updateApp = async (id: string) => {
const app = await this.queries.getApp(id);
+ const appStatusBeforeUpdate = app?.status;
if (!app) {
throw new TranslatedError('server-messages.errors.app-not-found', { id });
@@ -355,17 +356,36 @@ export class AppServiceClass {
if (success) {
const appInfo = getAppInfo(app.id, app.status);
- await this.queries.updateApp(id, { status: 'running', version: appInfo?.tipi_version });
+ await this.queries.updateApp(id, { version: appInfo?.tipi_version });
+ if (appStatusBeforeUpdate === 'running') {
+ await this.startApp(id);
+ } else {
+ await this.queries.updateApp(id, { status: appStatusBeforeUpdate });
+ }
} else {
await this.queries.updateApp(id, { status: 'stopped' });
Logger.error(`Failed to update app ${id}: ${stdout}`);
throw new TranslatedError('server-messages.errors.app-failed-to-update', { id });
}
- const updatedApp = await this.queries.updateApp(id, { status: 'stopped' });
+ const updatedApp = await this.getApp(id);
return updatedApp;
};
+ /**
+ * Reset App with the specified ID
+ *
+ * @param {string} id - ID of the app to reset
+ * @throws {Error} - If the app is not found or if the update process fails.
+ */
+ public resetApp = async (id: string) => {
+ const appInfo = await this.getApp(id);
+
+ await this.stopApp(id);
+ await this.uninstallApp(id);
+ await this.installApp(id, castAppConfig(appInfo.config));
+ };
+
/**
* Returns a list of all installed apps
*/
diff --git a/src/server/services/system/system.service.test.ts b/src/server/services/system/system.service.test.ts
index 0cef577a..ea030ede 100644
--- a/src/server/services/system/system.service.test.ts
+++ b/src/server/services/system/system.service.test.ts
@@ -106,21 +106,3 @@ describe('Test: getVersion', () => {
expect(version2.current).toBeDefined();
});
});
-
-describe('Test: restart', () => {
- it('Should return true', async () => {
- // Act
- const restart = await SystemService.restart();
-
- // Assert
- expect(restart).toBeTruthy();
- });
-
- it('should throw an error in demo mode', async () => {
- // Arrange
- await setConfig('demoMode', true);
-
- // Act & Assert
- await expect(SystemService.restart()).rejects.toThrow('server-messages.errors.not-allowed-in-demo');
- });
-});
diff --git a/src/server/services/system/system.service.ts b/src/server/services/system/system.service.ts
index 813876fd..e125f25b 100644
--- a/src/server/services/system/system.service.ts
+++ b/src/server/services/system/system.service.ts
@@ -1,15 +1,10 @@
import { z } from 'zod';
import axios from 'redaxios';
-import { TranslatedError } from '@/server/utils/errors';
-import { EventDispatcher } from '@/server/core/EventDispatcher';
import { TipiCache } from '@/server/core/TipiCache';
import { readJsonFile } from '../../common/fs.helpers';
import { Logger } from '../../core/Logger';
import { getConfig } from '../../core/TipiConfig';
-const SYSTEM_STATUS = ['UPDATING', 'RESTARTING', 'RUNNING'] as const;
-type SystemStatus = (typeof SYSTEM_STATUS)[keyof typeof SYSTEM_STATUS];
-
const systemInfoSchema = z.object({
cpu: z.object({
load: z.number().default(0),
@@ -74,28 +69,4 @@ export class SystemServiceClass {
return info.data;
};
-
- public restart = async (): Promise => {
- if (getConfig().NODE_ENV === 'development') {
- throw new TranslatedError('server-messages.errors.not-allowed-in-dev');
- }
-
- if (getConfig().demoMode) {
- throw new TranslatedError('server-messages.errors.not-allowed-in-demo');
- }
-
- const cache = new TipiCache('restart');
- await cache.set('status', 'RESTARTING', 360);
- await cache.close();
-
- const dispatcher = new EventDispatcher('restart');
- dispatcher.dispatchEvent({ type: 'system', command: 'restart' });
- await dispatcher.close();
-
- return true;
- };
-
- public static status = (): { status: SystemStatus } => ({
- status: getConfig().status,
- });
}
