2023-03-12 16:00:57 +01:00
|
|
|
// GoToSocial
|
|
|
|
// Copyright (C) GoToSocial Authors admin@gotosocial.org
|
|
|
|
// SPDX-License-Identifier: AGPL-3.0-or-later
|
|
|
|
//
|
|
|
|
// This program is free software: you can redistribute it and/or modify
|
|
|
|
// it under the terms of the GNU Affero General Public License as published by
|
|
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
|
|
// (at your option) any later version.
|
|
|
|
//
|
|
|
|
// This program is distributed in the hope that it will be useful,
|
|
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
// GNU Affero General Public License for more details.
|
|
|
|
//
|
|
|
|
// You should have received a copy of the GNU Affero General Public License
|
|
|
|
// along with this program. If not, see <http://www.gnu.org/licenses/>.
|
2021-12-07 13:31:39 +01:00
|
|
|
|
|
|
|
package config
|
|
|
|
|
2022-12-11 14:03:15 +01:00
|
|
|
import (
|
|
|
|
"time"
|
|
|
|
|
|
|
|
"codeberg.org/gruf/go-bytesize"
|
|
|
|
"github.com/coreos/go-oidc/v3/oidc"
|
2023-11-17 11:35:28 +01:00
|
|
|
"github.com/superseriousbusiness/gotosocial/internal/language"
|
2022-12-11 14:03:15 +01:00
|
|
|
)
|
2021-12-07 13:31:39 +01:00
|
|
|
|
2022-05-30 14:41:24 +02:00
|
|
|
// Defaults contains a populated Configuration with reasonable defaults. Note that
|
|
|
|
// if you use this, you will still need to set Host, and, if desired, ConfigPath.
|
|
|
|
var Defaults = Configuration{
|
2023-08-21 20:07:55 +02:00
|
|
|
LogLevel: "info",
|
|
|
|
LogTimestampFormat: "02/01/2006 15:04:05.000",
|
|
|
|
LogDbQueries: false,
|
|
|
|
ApplicationName: "gotosocial",
|
|
|
|
LandingPageUser: "",
|
|
|
|
ConfigPath: "",
|
|
|
|
Host: "",
|
|
|
|
AccountDomain: "",
|
|
|
|
Protocol: "https",
|
|
|
|
BindAddress: "0.0.0.0",
|
|
|
|
Port: 8080,
|
|
|
|
TrustedProxies: []string{"127.0.0.1/32", "::1"}, // localhost
|
2021-12-07 13:31:39 +01:00
|
|
|
|
2023-01-26 15:12:48 +01:00
|
|
|
DbType: "postgres",
|
|
|
|
DbAddress: "",
|
|
|
|
DbPort: 5432,
|
|
|
|
DbUser: "",
|
|
|
|
DbPassword: "",
|
|
|
|
DbDatabase: "gotosocial",
|
|
|
|
DbTLSMode: "disable",
|
|
|
|
DbTLSCACert: "",
|
|
|
|
DbMaxOpenConnsMultiplier: 8,
|
|
|
|
DbSqliteJournalMode: "WAL",
|
|
|
|
DbSqliteSynchronous: "NORMAL",
|
|
|
|
DbSqliteCacheSize: 8 * bytesize.MiB,
|
[performance] refactoring + add fave / follow / request / visibility caching (#1607)
* refactor visibility checking, add caching for visibility
* invalidate visibility cache items on account / status deletes
* fix requester ID passed to visibility cache nil ptr
* de-interface caches, fix home / public timeline caching + visibility
* finish adding code comments for visibility filter
* fix angry goconst linter warnings
* actually finish adding filter visibility code comments for timeline functions
* move home timeline status author check to after visibility
* remove now-unused code
* add more code comments
* add TODO code comment, update printed cache start names
* update printed cache names on stop
* start adding separate follow(request) delete db functions, add specific visibility cache tests
* add relationship type caching
* fix getting local account follows / followed-bys, other small codebase improvements
* simplify invalidation using cache hooks, add more GetAccountBy___() functions
* fix boosting to return 404 if not boostable but no error (to not leak status ID)
* remove dead code
* improved placement of cache invalidation
* update license headers
* add example follow, follow-request config entries
* add example visibility cache configuration to config file
* use specific PutFollowRequest() instead of just Put()
* add tests for all GetAccountBy()
* add GetBlockBy() tests
* update block to check primitive fields
* update and finish adding Get{Account,Block,Follow,FollowRequest}By() tests
* fix copy-pasted code
* update envparsing test
* whitespace
* fix bun struct tag
* add license header to gtscontext
* fix old license header
* improved error creation to not use fmt.Errorf() when not needed
* fix various rebase conflicts, fix account test
* remove commented-out code, fix-up mention caching
* fix mention select bun statement
* ensure mention target account populated, pass in context to customrenderer logging
* remove more uncommented code, fix typeutil test
* add statusfave database model caching
* add status fave cache configuration
* add status fave cache example config
* woops, catch missed error. nice catch linter!
* add back testrig panic on nil db
* update example configuration to match defaults, slight tweak to cache configuration defaults
* update envparsing test with new defaults
* fetch followingget to use the follow target account
* use accounnt.IsLocal() instead of empty domain check
* use constants for the cache visibility type check
* use bun.In() for notification type restriction in db query
* include replies when fetching PublicTimeline() (to account for single-author threads in Visibility{}.StatusPublicTimelineable())
* use bun query building for nested select statements to ensure working with postgres
* update public timeline future status checks to match visibility filter
* same as previous, for home timeline
* update public timeline tests to dynamically check for appropriate statuses
* migrate accounts to allow unique constraint on public_key
* provide minimal account with publicKey
---------
Signed-off-by: kim <grufwub@gmail.com>
Co-authored-by: tsmethurst <tobi.smethurst@protonmail.com>
2023-03-28 15:03:14 +02:00
|
|
|
DbSqliteBusyTimeout: time.Minute * 30,
|
2021-12-07 13:31:39 +01:00
|
|
|
|
|
|
|
WebTemplateBaseDir: "./web/template/",
|
|
|
|
WebAssetBaseDir: "./web/assets/",
|
|
|
|
|
2023-09-21 12:12:04 +02:00
|
|
|
InstanceFederationMode: InstanceFederationModeDefault,
|
2024-02-27 13:22:05 +01:00
|
|
|
InstanceFederationSpamFilter: false,
|
2022-09-23 21:27:35 +02:00
|
|
|
InstanceExposePeers: false,
|
|
|
|
InstanceExposeSuspended: false,
|
2023-01-25 18:06:41 +01:00
|
|
|
InstanceExposeSuspendedWeb: false,
|
2022-09-23 21:27:35 +02:00
|
|
|
InstanceDeliverToSharedInboxes: true,
|
2023-11-17 11:35:28 +01:00
|
|
|
InstanceLanguages: make(language.Languages, 0),
|
2022-06-23 16:54:54 +02:00
|
|
|
|
2024-04-15 14:41:15 +02:00
|
|
|
AccountsRegistrationOpen: false,
|
2021-12-07 13:31:39 +01:00
|
|
|
AccountsReasonRequired: true,
|
2022-09-12 13:14:29 +02:00
|
|
|
AccountsAllowCustomCSS: false,
|
2023-05-25 15:18:15 +02:00
|
|
|
AccountsCustomCSSLength: 10000,
|
2021-12-07 13:31:39 +01:00
|
|
|
|
|
|
|
MediaDescriptionMinChars: 0,
|
2024-02-23 19:28:09 +01:00
|
|
|
MediaDescriptionMaxChars: 1500,
|
2023-07-21 16:22:59 +02:00
|
|
|
MediaRemoteCacheDays: 7,
|
2024-07-12 11:39:47 +02:00
|
|
|
MediaLocalMaxSize: 40 * bytesize.MiB,
|
|
|
|
MediaRemoteMaxSize: 40 * bytesize.MiB,
|
2022-12-11 14:03:15 +01:00
|
|
|
MediaEmojiLocalMaxSize: 50 * bytesize.KiB,
|
|
|
|
MediaEmojiRemoteMaxSize: 100 * bytesize.KiB,
|
2023-10-30 18:35:11 +01:00
|
|
|
MediaCleanupFrom: "00:00", // Midnight.
|
|
|
|
MediaCleanupEvery: 24 * time.Hour, // 1/day.
|
2024-08-03 16:40:26 +02:00
|
|
|
MediaFfmpegPoolSize: 1,
|
2021-12-07 13:31:39 +01:00
|
|
|
|
|
|
|
StorageBackend: "local",
|
2021-12-20 15:19:53 +01:00
|
|
|
StorageLocalBasePath: "/gotosocial/storage",
|
2022-07-03 12:08:30 +02:00
|
|
|
StorageS3UseSSL: true,
|
2022-11-11 12:03:18 +01:00
|
|
|
StorageS3Proxy: false,
|
2024-07-31 14:44:18 +02:00
|
|
|
StorageS3RedirectURL: "",
|
2021-12-07 13:31:39 +01:00
|
|
|
|
|
|
|
StatusesMaxChars: 5000,
|
|
|
|
StatusesPollMaxOptions: 6,
|
|
|
|
StatusesPollOptionMaxChars: 50,
|
|
|
|
StatusesMediaMaxFiles: 6,
|
|
|
|
|
2022-01-30 14:57:33 +01:00
|
|
|
LetsEncryptEnabled: false,
|
2021-12-07 13:31:39 +01:00
|
|
|
LetsEncryptPort: 80,
|
|
|
|
LetsEncryptCertDir: "/gotosocial/storage/certs",
|
|
|
|
LetsEncryptEmailAddress: "",
|
|
|
|
|
2023-03-04 18:24:02 +01:00
|
|
|
TLSCertificateChain: "",
|
|
|
|
TLSCertificateKey: "",
|
|
|
|
|
2021-12-07 13:31:39 +01:00
|
|
|
OIDCEnabled: false,
|
|
|
|
OIDCIdpName: "",
|
|
|
|
OIDCSkipVerification: false,
|
|
|
|
OIDCIssuer: "",
|
|
|
|
OIDCClientID: "",
|
|
|
|
OIDCClientSecret: "",
|
|
|
|
OIDCScopes: []string{oidc.ScopeOpenID, "profile", "email", "groups"},
|
2022-12-06 14:15:56 +01:00
|
|
|
OIDCLinkExisting: false,
|
2021-12-07 13:31:39 +01:00
|
|
|
|
2023-03-19 13:11:46 +01:00
|
|
|
SMTPHost: "",
|
|
|
|
SMTPPort: 0,
|
|
|
|
SMTPUsername: "",
|
|
|
|
SMTPPassword: "",
|
2023-07-12 10:28:41 +02:00
|
|
|
SMTPFrom: "",
|
2023-03-19 13:11:46 +01:00
|
|
|
SMTPDiscloseRecipients: false,
|
2021-12-12 18:00:20 +01:00
|
|
|
|
2023-05-09 19:19:48 +02:00
|
|
|
TracingEnabled: false,
|
|
|
|
TracingTransport: "grpc",
|
|
|
|
TracingEndpoint: "",
|
|
|
|
TracingInsecureTransport: false,
|
|
|
|
|
2023-11-20 16:43:55 +01:00
|
|
|
MetricsEnabled: false,
|
|
|
|
MetricsAuthEnabled: false,
|
|
|
|
|
2021-12-12 18:00:20 +01:00
|
|
|
SyslogEnabled: false,
|
|
|
|
SyslogProtocol: "udp",
|
|
|
|
SyslogAddress: "localhost:514",
|
2022-06-03 15:40:38 +02:00
|
|
|
|
2023-01-04 11:57:59 +01:00
|
|
|
AdvancedCookiesSamesite: "lax",
|
|
|
|
AdvancedRateLimitRequests: 300, // 1 per second per 5 minutes
|
2023-08-23 14:32:27 +02:00
|
|
|
AdvancedRateLimitExceptions: []string{},
|
|
|
|
AdvancedThrottlingMultiplier: 8, // 8 open requests per CPU
|
2023-07-12 10:28:41 +02:00
|
|
|
AdvancedThrottlingRetryAfter: time.Second * 30,
|
|
|
|
AdvancedSenderMultiplier: 2, // 2 senders per CPU
|
2023-08-20 13:35:55 +02:00
|
|
|
AdvancedCSPExtraURIs: []string{},
|
2023-12-18 15:18:25 +01:00
|
|
|
AdvancedHeaderFilterMode: RequestHeaderFilterModeDisabled,
|
2022-12-11 14:03:15 +01:00
|
|
|
|
|
|
|
Cache: CacheConfiguration{
|
2023-08-03 11:34:35 +02:00
|
|
|
// Rough memory target that the total
|
|
|
|
// size of all State.Caches will attempt
|
|
|
|
// to remain with. Emphasis on *rough*.
|
2023-08-14 18:08:19 +02:00
|
|
|
MemoryTarget: 100 * bytesize.MiB,
|
2023-08-03 11:34:35 +02:00
|
|
|
|
|
|
|
// These ratios signal what percentage
|
|
|
|
// of the available cache target memory
|
|
|
|
// is allocated to each object type's
|
|
|
|
// cache.
|
|
|
|
//
|
|
|
|
// These are weighted by a totally
|
|
|
|
// assorted mixture of priority, and
|
|
|
|
// manual twiddling to get the generated
|
|
|
|
// cache capacity ratios within normal
|
|
|
|
// amounts dependent size of the models.
|
|
|
|
//
|
|
|
|
// when TODO items in the size.go source
|
|
|
|
// file have been addressed, these should
|
|
|
|
// be able to make some more sense :D
|
2024-11-29 18:06:32 +01:00
|
|
|
AccountMemRatio: 5,
|
|
|
|
AccountNoteMemRatio: 1,
|
|
|
|
AccountSettingsMemRatio: 0.1,
|
|
|
|
AccountStatsMemRatio: 2,
|
|
|
|
ApplicationMemRatio: 0.1,
|
|
|
|
BlockMemRatio: 2,
|
|
|
|
BlockIDsMemRatio: 3,
|
|
|
|
BoostOfIDsMemRatio: 3,
|
|
|
|
ClientMemRatio: 0.1,
|
|
|
|
ConversationMemRatio: 1,
|
|
|
|
ConversationLastStatusIDsMemRatio: 2,
|
|
|
|
DomainPermissionDraftMemRation: 0.5,
|
|
|
|
DomainPermissionSubscriptionMemRation: 0.5,
|
|
|
|
EmojiMemRatio: 3,
|
|
|
|
EmojiCategoryMemRatio: 0.1,
|
|
|
|
FilterMemRatio: 0.5,
|
|
|
|
FilterKeywordMemRatio: 0.5,
|
|
|
|
FilterStatusMemRatio: 0.5,
|
|
|
|
FollowMemRatio: 2,
|
|
|
|
FollowIDsMemRatio: 4,
|
|
|
|
FollowRequestMemRatio: 2,
|
|
|
|
FollowRequestIDsMemRatio: 2,
|
|
|
|
FollowingTagIDsMemRatio: 2,
|
|
|
|
InReplyToIDsMemRatio: 3,
|
|
|
|
InstanceMemRatio: 1,
|
|
|
|
InteractionRequestMemRatio: 1,
|
|
|
|
ListMemRatio: 1,
|
|
|
|
ListIDsMemRatio: 2,
|
|
|
|
ListedIDsMemRatio: 2,
|
|
|
|
MarkerMemRatio: 0.5,
|
|
|
|
MediaMemRatio: 4,
|
|
|
|
MentionMemRatio: 2,
|
|
|
|
MoveMemRatio: 0.1,
|
|
|
|
NotificationMemRatio: 2,
|
|
|
|
PollMemRatio: 1,
|
|
|
|
PollVoteMemRatio: 2,
|
|
|
|
PollVoteIDsMemRatio: 2,
|
|
|
|
ReportMemRatio: 1,
|
|
|
|
SinBinStatusMemRatio: 0.5,
|
|
|
|
StatusMemRatio: 5,
|
|
|
|
StatusBookmarkMemRatio: 0.5,
|
|
|
|
StatusBookmarkIDsMemRatio: 2,
|
|
|
|
StatusFaveMemRatio: 2,
|
|
|
|
StatusFaveIDsMemRatio: 3,
|
|
|
|
TagMemRatio: 2,
|
|
|
|
ThreadMuteMemRatio: 0.2,
|
|
|
|
TokenMemRatio: 0.75,
|
|
|
|
TombstoneMemRatio: 0.5,
|
|
|
|
UserMemRatio: 0.25,
|
|
|
|
UserMuteMemRatio: 2,
|
|
|
|
UserMuteIDsMemRatio: 3,
|
|
|
|
WebfingerMemRatio: 0.1,
|
|
|
|
VisibilityMemRatio: 2,
|
2022-12-11 14:03:15 +01:00
|
|
|
},
|
2023-02-11 12:48:38 +01:00
|
|
|
|
2023-07-07 16:17:39 +02:00
|
|
|
HTTPClient: HTTPClientConfiguration{
|
2023-08-01 19:50:17 +02:00
|
|
|
AllowIPs: make([]string, 0),
|
|
|
|
BlockIPs: make([]string, 0),
|
2024-08-19 14:56:43 +02:00
|
|
|
Timeout: 30 * time.Second,
|
2023-08-01 19:50:17 +02:00
|
|
|
TLSInsecureSkipVerify: false,
|
2023-07-07 16:17:39 +02:00
|
|
|
},
|
|
|
|
|
2023-02-11 12:48:38 +01:00
|
|
|
AdminMediaPruneDryRun: true,
|
2023-02-17 12:02:29 +01:00
|
|
|
|
|
|
|
RequestIDHeader: "X-Request-Id",
|
2023-05-21 17:12:47 +02:00
|
|
|
|
|
|
|
LogClientIP: true,
|
2021-12-07 13:31:39 +01:00
|
|
|
}
|