Skip to content

Clarify settings requirements #4670

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ildyria wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Clarify settings requirements #4670

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
eed02c3
Clarify settings requirements
ildyria Aug 25, 2026
8772301
More UIUX things
ildyria Aug 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions app/Http/Resources/Models/ConfigResource.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,9 @@ class ConfigResource extends Data
public bool $require_se;
public int|null $order;

/** @var array<int,string> */
public array $required_keys;

public function __construct(Configs $c)
{
$this->key = $c->key;
Expand All @@ -35,6 +38,7 @@ public function __construct(Configs $c)
$this->require_se = $c->level > 0;
$this->is_expert = $c->is_expert;
$this->order = (config('app.env', 'dev') === 'dev') ? $c->order : null;
$this->required_keys = $c->required_keys !== null && $c->required_keys !== '' ? explode(',', $c->required_keys) : [];
}

public static function fromModel(Configs $c): ConfigResource
Expand Down
3 changes: 2 additions & 1 deletion app/Models/Configs.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@
* @property bool $not_on_docker
* @property int $order
* @property bool $is_expert
* @property string|null $required_keys
*
* @method static ConfigsBuilder|Configs addSelect($column)
* @method static ConfigsBuilder|Configs join(string $table, string $first, string $operator = null, string $second = null, string $type = 'inner', string $where = false)
Expand Down Expand Up @@ -69,7 +70,7 @@ class Configs extends Model
*
* @var list<string>
*/
protected $fillable = ['key', 'value', 'cat', 'type_range', 'is_secret', 'description', 'level', 'not_on_docker', 'order'];
protected $fillable = ['key', 'value', 'cat', 'type_range', 'is_secret', 'description', 'level', 'not_on_docker', 'order', 'required_keys'];

/**
* this is a parameter for Laravel to indicate that there is no created_at, updated_at columns.
Expand Down
180 changes: 180 additions & 0 deletions database/migrations/2026_08_25_000001_add_config_required_keys.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,180 @@
<?php

/**
* SPDX-License-Identifier: MIT
* Copyright (c) 2017-2018 Tobias Reich
* Copyright (c) 2018-2026 LycheeOrg.
*/

use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\DB;
use Illuminate\Support\Facades\Schema;

return new class() extends Migration {
public const COL = 'required_keys';

/**
* Run the migrations.
*/
public function up(): void
{
Schema::table('configs', function (Blueprint $table) {
$table->string(self::COL)->nullable()->after('is_expert');
});

// Landing page (cat: Mod Welcome), root: landing_page_enable
DB::table('configs')->whereIn('key', [
'landing_layout',
'landing_intro_screen_enabled',
'landing_hero_text_position',
'landing_hero_text_color',
'landing_hero_text_opacity',
'landing_animation_preset',
'landing_about_enabled',
'landing_featured_items_enabled',
'landing_cta_text',
'landing_cta_position',
'landing_cta_shift_type',
'landing_cta_shift_x',
'landing_cta_shift_x_direction',
'landing_cta_shift_y',
'landing_cta_shift_y_direction',
'landing_meridian_explore_offset',
'landing_meridian_contact_offset',
'landing_meridian_explore_line_position',
'landing_meridian_contact_line_position',
'landing_login_position',
'landing_backdrop_opacity',
])->update([self::COL => 'landing_page_enable']);
DB::table('configs')->where('key', 'landing_about_text')->update([self::COL => 'landing_page_enable,landing_about_enabled']);
DB::table('configs')->whereIn('key', [
'landing_featured_items_mode',
'landing_featured_items_count',
])->update([self::COL => 'landing_page_enable,landing_featured_items_enabled']);

// Timeline (cat: Mod Timeline), two independent roots
DB::table('configs')->whereIn('key', [
'timeline_photos_public',
'timeline_photos_granularity',
'timeline_photos_order',
'timeline_photos_layout',
'timeline_photos_pagination_limit',
'timeline_photo_date_format_year',
'timeline_photo_date_format_month',
'timeline_photo_date_format_day',
'timeline_photo_date_format_hour',
])->update([self::COL => 'timeline_photos_enabled']);
DB::table('configs')->whereIn('key', [
'timeline_albums_public',
'timeline_albums_granularity',
'timeline_albums_root_enabled',
'timeline_album_date_format_year',
'timeline_album_date_format_month',
'timeline_album_date_format_day',
])->update([self::COL => 'timeline_albums_enabled']);

// AI Vision (cat: AI Vision), root: ai_vision_enabled
DB::table('configs')->whereIn('key', [
'ai_vision_face_enabled',
'ai_vision_nsfw_enabled',
])->update([self::COL => 'ai_vision_enabled']);
DB::table('configs')->whereIn('key', [
'ai_vision_face_permission_mode',
'ai_vision_face_selfie_confidence_threshold',
'ai_vision_face_person_is_searchable_default',
'ai_vision_face_allow_user_claim',
'ai_vision_face_overlay_enabled',
'ai_vision_face_recognition_warning',
])->update([self::COL => 'ai_vision_enabled,ai_vision_face_enabled']);
DB::table('configs')->where('key', 'ai_vision_face_overlay_default_visibility')
->update([self::COL => 'ai_vision_enabled,ai_vision_face_enabled,ai_vision_face_overlay_enabled']);
DB::table('configs')->whereIn('key', [
'ai_vision_nsfw_preset',
'ai_vision_nsfw_check_block_action',
'ai_vision_nsfw_monitor_block_action',
'ai_vision_nsfw_trust_but_verify_block_action',
'ai_vision_nsfw_trust_block_action',
'ai_vision_nsfw_sensitive_album_action',
'ai_vision_nsfw_sensitive_no_album_action',
'ai_vision_nsfw_scan_trusted_users',
'ai_vision_nsfw_monitor_hide_on_scan',
'ai_vision_nsfw_trust_but_verify_hide_on_scan',
'ai_vision_nsfw_trust_hide_on_scan',
])->update([self::COL => 'ai_vision_enabled,ai_vision_nsfw_enabled']);

// Watermarker (cat: Mod Watermarker), root: watermark_enabled
DB::table('configs')->whereIn('key', [
'watermark_photo_id',
'watermark_random_path',
'watermark_public',
'watermark_logged_in_users_enabled',
'watermark_original',
'watermark_size',
'watermark_opacity',
'watermark_position',
'watermark_shift_type',
'watermark_shift_x',
'watermark_shift_x_direction',
'watermark_shift_y',
'watermark_shift_y_direction',
'watermark_optout_disabled',
])->update([self::COL => 'watermark_enabled']);

// Frame (cat: Mod Frame), root: mod_frame_enabled
DB::table('configs')->whereIn('key', [
'random_album_id',
'mod_frame_refresh',
])->update([self::COL => 'mod_frame_enabled']);

// Map (cat: Mod Map), root: map_display
DB::table('configs')->whereIn('key', [
'map_provider',
'map_include_subalbums',
'map_display_direction',
'map_display_public',
'gps_coordinate_display',
'gps_coordinate_display_public',
])->update([self::COL => 'map_display']);

// Flow (cat: Mod Flow), root: flow_enabled
DB::table('configs')->whereIn('key', [
'flow_public',
'flow_base',
'flow_max_items',
'flow_strategy',
'flow_include_sub_albums',
'flow_include_photos_from_children',
'flow_open_album_on_click',
'flow_display_open_album_button',
'flow_highlight_first_picture',
'flow_min_max_enabled',
'flow_display_statistics',
'flow_compact_mode_enabled',
'flow_image_header_enabled',
'flow_carousel_enabled',
'date_format_flow_published',
'flow_blur_nsfw_enabled',
'hide_nsfw_in_flow',
])->update([self::COL => 'flow_enabled']);
DB::table('configs')->whereIn('key', [
'flow_min_max_order',
'date_format_flow_min_max',
])->update([self::COL => 'flow_enabled,flow_min_max_enabled']);
DB::table('configs')->whereIn('key', [
'flow_image_header_cover',
'flow_image_header_height',
])->update([self::COL => 'flow_enabled,flow_image_header_enabled']);
DB::table('configs')->where('key', 'flow_carousel_height')->update([self::COL => 'flow_enabled,flow_carousel_enabled']);
}

/**
* Reverse the migrations.
*/
public function down(): void
{
Schema::table('configs', function (Blueprint $table) {
$table->dropColumn(self::COL);
});
}
};
1 change: 1 addition & 0 deletions resources/js/lychee.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -896,6 +896,7 @@ declare namespace App {
is_expert: boolean;
require_se: boolean;
order: number | null;
required_keys: string[];
};
export type ContactMessageResource = {
id: number;
Expand Down
3 changes: 2 additions & 1 deletion resources/js/v8/components/settings/AllSettings.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
:toggleable="true"
class="mb-4 hover:border-primary-500 pt-2"
>
<ConfigGroup :configs="configGroup.configs" @filled="filled" @reset="reset" />
<ConfigGroup :configs="configGroup.configs" :modified="props.modified" @filled="filled" @reset="reset" />
</Fieldset>
</div>
</div>
Expand All @@ -31,6 +31,7 @@ const { tCatName } = useTranslation();
const props = defineProps<{
configs: App.Http.Resources.Models.ConfigCategoryResource[];
hash: string;
modified: App.Http.Resources.Editable.EditableConfigResource[];
}>();

const emits = defineEmits<{
Expand Down
Loading
Loading