chore: add deprecation notice for oidc user file

This commit is contained in:
Aarnav Tale
2025-08-21 12:37:25 -04:00
parent 9bc8483a8f
commit d7b1e19985
3 changed files with 19 additions and 5 deletions
+1 -1
View File
@@ -91,7 +91,7 @@ const partialOidcConfig = type({
token_endpoint_auth_method:
'"client_secret_basic" | "client_secret_post" | "client_secret_jwt"?',
redirect_uri: 'string.url?',
user_storage_file: 'string = "/var/lib/headplane/users.json"',
user_storage_file: 'string?',
disable_api_key_login: stringToBool.optional(),
headscale_api_key: 'string?',
headscale_api_key_path: 'string?',
+17
View File
@@ -221,6 +221,23 @@ async function migrateUserDatabase(path: string, db: LibSQLDatabase) {
log.info('config', 'Migrating old user database from %s', path);
const realPath = resolve(path);
log.warn(
'config',
'oidc.user_storage_file is deprecated and will be removed in Headplane 0.7.0',
);
log.warn(
'config',
'You can ignore this warning if you do not use OIDC authentication.',
);
log.warn(
'config',
'Data will be automatically migrated to the new SQL database.',
);
log.warn(
'config',
'Refer to server.data_path to ensure this path is mounted correctly is using Docker.',
);
try {
const handle = await open(realPath, 'a+');
await handle.close();