diff --git a/README.md b/README.md index 8bf08af1..484e6274 100644 --- a/README.md +++ b/README.md @@ -109,23 +109,29 @@ Application behavior can be changed by configuring the following environment var - `NEXT_PUBLIC_PRESERVE_ORIGINAL_UPLOADS = 1` prevents photo uploads being compressed before storing - `NEXT_PUBLIC_BLUR_DISABLED = 1` prevents image blur data being stored and displayed (potentially useful for limiting Postgres usage) +#### Visual + +- `NEXT_PUBLIC_DEFAULT_THEME = light | dark` sets preferred initial theme (defaults to `system` when not configured) +- `NEXT_PUBLIC_MATTE_PHOTOS = 1` constrains the size of each photo, and enables a surrounding border (potentially useful for photos with tall aspect ratios) + #### Display - `NEXT_PUBLIC_HIDE_EXIF_DATA = 1` hides EXIF data in photo details and OG images (potentially useful for portfolios, which don't focus on photography) - `NEXT_PUBLIC_HIDE_ZOOM_CONTROLS = 1` hides fullscreen photo zoom controls - `NEXT_PUBLIC_HIDE_TAKEN_AT_TIME = 1` hides taken at time from photo meta -- `NEXT_PUBLIC_HIDE_SOCIAL = 1` removes X button from share modal +- `NEXT_PUBLIC_HIDE_SOCIAL = 1` removes X (formerly Twitter) button from share modal - `NEXT_PUBLIC_HIDE_FILM_SIMULATIONS = 1` prevents Fujifilm simulations showing up in `/grid` sidebar and CMD-K search results - `NEXT_PUBLIC_HIDE_REPO_LINK = 1` removes footer link to repo -#### Settings +#### Grid - `NEXT_PUBLIC_GRID_HOMEPAGE = 1` shows grid layout on homepage -- `NEXT_PUBLIC_DEFAULT_THEME = light | dark` sets preferred initial theme (defaults to `system` when not configured) -- `NEXT_PUBLIC_MATTE_PHOTOS = 1` constrains the size of each photo, and enables a surrounding border (potentially useful for photos with tall aspect ratios) +- `NEXT_PUBLIC_GRID_ASPECT_RATIO = 1.5` sets aspect ratio for grid tiles (defaults to `1`—setting to `0` removes the constraint) +- `NEXT_PUBLIC_SHOW_LARGE_THUMBNAILS = 1` ensures large thumbnails on photo grid views (if not configured, density is based on aspect ratio) + +#### Settings - `NEXT_PUBLIC_GEO_PRIVACY = 1` disables collection/display of location-based data (⚠️ re-compresses uploaded images in order to remove GPS information) - `NEXT_PUBLIC_ALLOW_PUBLIC_DOWNLOADS = 1` enables public photo downloads for all visitors (⚠️ may result in increased bandwidth usage) - `NEXT_PUBLIC_PUBLIC_API = 1` enables public API available at `/api` - `NEXT_PUBLIC_IGNORE_PRIORITY_ORDER = 1` prevents `priority_order` field affecting photo order -- `NEXT_PUBLIC_GRID_ASPECT_RATIO = 1.5` sets aspect ratio for grid tiles (defaults to `1`—setting to `0` removes the constraint) - `NEXT_PUBLIC_SHOW_LARGE_THUMBNAILS = 1` ensures large thumbnails on photo grid views - `NEXT_PUBLIC_OG_TEXT_ALIGNMENT = BOTTOM` keeps OG image text bottom aligned (default is top) diff --git a/src/site/SiteChecklistClient.tsx b/src/site/SiteChecklistClient.tsx index 38861a81..5faff5ee 100644 --- a/src/site/SiteChecklistClient.tsx +++ b/src/site/SiteChecklistClient.tsx @@ -26,6 +26,8 @@ import { RiSpeedMiniLine } from 'react-icons/ri'; import Link from 'next/link'; import SecretGenerator from './SecretGenerator'; import CopyButton from '@/components/CopyButton'; +import { PiPaintBrushHousehold } from 'react-icons/pi'; +import { IoMdGrid } from 'react-icons/io'; export default function SiteChecklistClient({ // Storage @@ -58,6 +60,10 @@ export default function SiteChecklistClient({ arePhotoCategoriesStaticallyOptimized, areOriginalUploadsPreserved, isBlurEnabled, + // Visual + hasDefaultTheme, + defaultTheme, + arePhotosMatted, // Display showExifInfo, showZoomControls, @@ -65,16 +71,14 @@ export default function SiteChecklistClient({ showSocial, showFilmSimulations, showRepoLink, - // Settings + // Grid isGridHomepageEnabled, - hasDefaultTheme, - defaultTheme, - arePhotosMatted, - isGeoPrivacyEnabled, gridAspectRatio, hasGridAspectRatio, gridDensity, hasGridDensityPreference, + // Settings + isGeoPrivacyEnabled, arePublicDownloadsEnabled, isPublicApiEnabled, isPriorityOrderEnabled, @@ -366,7 +370,6 @@ export default function SiteChecklistClient({ title="AI text generation" titleShort="AI" icon={} - experimental optional > + } + optional + > + + {'Set environment variable to \'light\' or \'dark\''} + {' '} + to configure initial theme + {' '} + (defaults to {'\'system\''}): + {renderEnvVars(['NEXT_PUBLIC_DEFAULT_THEME'])} + + + Set environment variable to {'"1"'} to constrain the size + {' '} + of each photo, and enable a surrounding border: + {renderEnvVars(['NEXT_PUBLIC_MATTE_PHOTOS'])} + + } @@ -475,7 +506,7 @@ export default function SiteChecklistClient({ {renderEnvVars(['NEXT_PUBLIC_HIDE_EXIF_DATA'])} @@ -499,7 +530,7 @@ export default function SiteChecklistClient({ > Set environment variable to {'"1"'} to hide {' '} - X button from share modal: + X (formerly Twitter) button from share modal: {renderEnvVars(['NEXT_PUBLIC_HIDE_SOCIAL'])} } + title="Grid" + icon={} optional > - - {'Set environment variable to \'light\' or \'dark\''} - {' '} - to configure initial theme - {' '} - (defaults to {'\'system\''}): - {renderEnvVars(['NEXT_PUBLIC_DEFAULT_THEME'])} - - - Set environment variable to {'"1"'} to constrain the size - {' '} - of each photo, and enable a surrounding border: - {renderEnvVars(['NEXT_PUBLIC_MATTE_PHOTOS'])} - - - Set environment variable to {'"1"'} to disable - collection/display of location-based data: - {renderEnvVars(['NEXT_PUBLIC_GEO_PRIVACY'])} - Set environment variable to {'"1"'} to ensure large thumbnails on photo grid views (if not configured, density is based on - aspect ratio configuration): + aspect ratio): {renderEnvVars(['NEXT_PUBLIC_SHOW_LARGE_THUMBNAILS'])} + + } + optional + > + + Set environment variable to {'"1"'} to disable + collection/display of location-based data: + {renderEnvVars(['NEXT_PUBLIC_GEO_PRIVACY'])} +