|
|
| Line 4: |
Line 4: |
|
| |
|
| == Configuration == | | == Configuration == |
| The following example should contain all configurable keys for the API server. It combines the output of <code>/api/v1/settings</code> and the minimal [https://github.com/VernissageApp/VernissageServer#configuration upstream example] as of v1.43.0. Long strings are replaced with <code>SHORTENED</code> in this example but they contain real defaults, so just check them on a running instance.
| | Check the [https://github.com/VernissageApp/VernissageServer#configuration upstream example] on how to configure the API server. |
| | |
| <syntaxhighlight lang="json">
| |
| {
| |
| "vernissage": {
| |
| "baseAddress": "http://localhost:8080",
| |
| "connectionString": "postgres://postgres:secretpass@localhost:5432/postgres",
| |
| "dbMaxConnectionsPerEventLoop": 1,
| |
| "dbConnectionPoolTimeoutSeconds": 10,
| |
| "dbConnectTimeoutSeconds": 10,
| |
| "queueUrl": "redis://127.0.0.1:6379",
| |
| "s3Address": "https://s3.eu-central-1.amazonaws.com",
| |
| "s3Region": "eu-central-1",
| |
| "s3Bucket": "your-bucket-test",
| |
| "s3AccessKeyId": "YOUR_ACCESS_KEY",
| |
| "s3SecretAccessKey": "YOUR_SECRET_KEY",
| |
| "s3Http1OnlyMode": "false",
| |
| "disableQueueJobs": "false",
| |
| "disableScheduledJobs": "false"
| |
| },
| |
| "alwaysCalculateCategory": false,
| |
| "clearAttachmentsJobEnabled": true,
| |
| "clearDeletedUsersJobEnabled": true,
| |
| "clearErrorItemsJobEnabled": true,
| |
| "clearFailedLoginsJobEnabled": true,
| |
| "clearQuickCaptchasJobEnabled": true,
| |
| "corsOrigin": "",
| |
| "createArchiveJobEnabled": true,
| |
| "customFileScript": "",
| |
| "customFileStyle": "",
| |
| "customInlineScript": "",
| |
| "customInlineStyle": "",
| |
| "deleteArchiveJobEnabled": true,
| |
| "emailFromAddress": "",
| |
| "emailFromName": "",
| |
| "emailHostname": "",
| |
| "emailPassword": "",
| |
| "emailPort": 465,
| |
| "emailSecureMethod": "none",
| |
| "emailUserName": "",
| |
| "eventsToStore": [],
| |
| "imageQuality": 85,
| |
| "imageSizeLimit": 10485760,
| |
| "imagesUrl": "",
| |
| "isOpenAIEnabled": false,
| |
| "isQuickCaptchaEnabled": false,
| |
| "isRegistrationByApprovalOpened": false,
| |
| "isRegistrationByInvitationsOpened": false,
| |
| "isRegistrationOpened": true,
| |
| "isWebPushEnabled": false,
| |
| "locationsJobEnabled": true,
| |
| "longPeriodTrendingJobEnabled": true,
| |
| "mastodonUrl": "",
| |
| "maxCharacters": 500,
| |
| "maxMediaAttachments": 4,
| |
| "maximumNumberOfInvitations": 10,
| |
| "minimumSecondsBetweenRegularStatuses": 60,
| |
| "minimumSecondsBetweenSilentStatuses": 1,
| |
| "openAIImageDescriptionPrompt": "SHORTENED",
| |
| "openAIImageHashtagsPrompt": "SHORTENED",
| |
| "openAIKey": "",
| |
| "openAIModel": "gpt-4-turbo",
| |
| "openAIProviderName": "OpenAI",
| |
| "openAIUrl": "https://api.openai.com/v1/chat/completions",
| |
| "patreonUrl": "",
| |
| "privacyPolicyContent": "SHORTENED",
| |
| "privacyPolicyUpdatedAt": "2025-01-18",
| |
| "purgeStatusesJobEnabled": true,
| |
| "rescheduleActivityPubJobEnabled": true,
| |
| "shortPeriodTrendingJobEnabled": true,
| |
| "showCamerasForAnonymous": false,
| |
| "showCategoriesForAnonymous": false,
| |
| "showEditorsChoiceForAnonymous": false,
| |
| "showEditorsUsersChoiceForAnonymous": false,
| |
| "showFilmsForAnonymous": false,
| |
| "showHashtagsForAnonymous": false,
| |
| "showLensesForAnonymous": false,
| |
| "showLocalTimelineForAnonymous": true,
| |
| "showNews": false,
| |
| "showNewsForAnonymous": false,
| |
| "showSharedBusinessCards": false,
| |
| "showTrendingForAnonymous": false,
| |
| "statusPurgeAfterDays": 180,
| |
| "systemDefaultUserId": "7690597177843813016",
| |
| "termsOfServiceContent": "SHORTENED",
| |
| "termsOfServiceUpdatedAt": "2025-01-18",
| |
| "totalCost": 0,
| |
| "usersSupport": 0,
| |
| "webContactUserId": "",
| |
| "webDescription": "",
| |
| "webEmail": "",
| |
| "webLanguages": "en",
| |
| "webLongDescription": "",
| |
| "webPushEndpoint": "",
| |
| "webPushSecretKey": "",
| |
| "webPushVapidPrivateKey": "",
| |
| "webPushVapidPublicKey": "",
| |
| "webPushVapidSubject": "",
| |
| "webThumbnail": "",
| |
| "webTitle": "Vernissage"
| |
| }
| |
| | |
| </syntaxhighlight>
| |
Vernissage is an application that enables users to share their photographs with others.
⚠︎
Warning: The packages and module(s) to run Vernissage are not published yet. When Swift v6 has reached master, a (draft) PR should have been opened.
Configuration
Check the upstream example on how to configure the API server.
