summaryrefslogtreecommitdiff
path: root/docs
AgeCommit message (Collapse)AuthorFiles
2022-12-15[bugfix] Use null for empty api status `language` (#1268)Libravatar tobi1
* [bugfix] Use null for empty api status `language` * update swagger docs
2022-12-15[docs] Update Apache docs to use 127.0.0.1 instead of localhost (#1266)Libravatar EchedeyLR1
* Update Apache docs to use 127.0.0.1 instead * Update apache-httpd.md
2022-12-14[docs] Update nginx docs to use 127.0.0.1 instead of localhost (#1264)Libravatar tobi1
Lots of these were appearing: ``` *459 connect() failed (111: Connection refused) while connecting to upstream ``` This change resolves it, see https://stackoverflow.com/a/52550758
2022-12-11[docs] Serve static assets with nginx (#1251)Libravatar Daniele Sluijters2
* [docs] Serve static assets with nginx This explains how to use nginx to serve static assets and offload GTS from that responsibility. It also shows how to have nginx add caching headers to indicate to clients how long they may cache an asset. * [docs] Move additional nginx config to advanced This moves a bunch of additional nginx configuration into the Advanced page instead. It declutters the nginx configuration page.
2022-12-11[docs] Caching webfinger with nginx (#1242)Libravatar Daniele Sluijters1
This explains how nginx can be used to cache webfinger responses and potentially serve stale responses in case GTS is down. This can be useful to do in order to ensure webfinger keeps working even if you're doing some maintenance.
2022-12-10[feature] Start implementing refetch of lost media files via ↵Libravatar tobi1
`/api/v1/admin/media_refetch` (#1221) * [chore] Move ShortcodeDomain to its own little util func * [feature] Add RefetchEmojis function to media manager * [feature] Expose admin media refresh via admin API * update following review feedback - change/fix log levels - make sure not to try to refetch local emojis - small style refactoring + comments * log on emoji refetch start Signed-off-by: kim <grufwub@gmail.com> Co-authored-by: kim <grufwub@gmail.com>
2022-12-09[docs] Update `CONTRIBUTING.md`, add pull request templates (#1216)Libravatar tobi1
* [docs] Update contributing.md - Add Pull Request process and guidelines. - Add feature/bug issue process. - Rearrange some sections for clarity. - Add overview of package structure. * [docs] Add build from source links * [chore] add pull request templates These link to the new CONTRIBUTING.md document, and include a checklist to validate that contributors have read the guidelines. * [docs] Put existing stub CoC in separate doc * update web related stuff in CONTRIBUTING.md Co-authored-by: f0x <f0x@cthu.lu>
2022-12-09[feature] Allow users to create + delete bookbarks, and view bookmarked ↵Libravatar Matthew Phillips1
statuses (#1168) * Implement Bookmarks * Update based on review comments * Update swagger doc * Fix argument passing to status.Bookmark * Update changed test * Updates based on latest PR review
2022-12-07[docs] encourage using loopback bind address (#1166)Libravatar Andrea4
2022-12-06[feature] overhaul the oidc system (#961)Libravatar Dominik Süß1
* [feature] overhaul the oidc system this allows for more flexible username handling and prevents account takeover using old email addresses * [feature] add migration path for old OIDC users * [feature] nicer error reporting for users * [docs] document the new OIDC flow * [fix] return early on oidc error * [docs]: add comments on the finalization logic
2022-12-05[docs] Remove filesystem logging directives from example systemd unit config ↵v0.6.0Libravatar f0x521
(#1206) * remove filesystem logging directives from example systemd unit config * [docs] Update docs to reflect new systemd config Co-authored-by: tsmethurst <tobi.smethurst@protonmail.com>
2022-11-30[docs] Add AppArmor profile for Debian and Ubuntu installations (#1183)Libravatar kernelmethod2
* Enable the 'admonitions' Markdown extension for Mkdocs. The admonitions extension to Python-Markdown allows you to include rST-style "admonitions" to Markdown documents, for instance, !!! note Here's an important note to keep in mind! In general, the current documentation uses bold text to try to achieve the same effect, which is a bit harder to notice and makes it difficult to differentiate between "here's something useful to know" versus "here there be dragons". * Add AppArmor profile and documentation for LSM-related sandboxing This commit adds an AppArmor profile for gotosocial in examples/apparmor/gotosocial. This will (hopefully) serve as a helpful security mitigation for people are planning on deploying GTS on a Debian-family Linux distribution. I've also updates the documentation to include some information about deploying GTS with either AppArmor or SELinux (moving the documentation for the former out of the "binary installation guide" docs).
2022-11-25[docs] Explain that before 0.6.0, account confirm was necessary. (#1149)Libravatar Phil Hagelberg2
Since the documentation site only shows the latest version of the docs, we need the docs to explain how to use the latest stable release, not just the latest git version.
2022-11-25[feature] Add `admin media prune orphaned` CLI command (#1146)Libravatar tobi1
* add FilePath regex * add `admin media prune orphaned` command * add prune orphaned function to media manager * don't mark flag as required * document admin media prune orphaned cmd * oh envparsing.sh you coy minx
2022-11-25[bugfix] Change emailVerified to true for admin account create (#1140)Libravatar Phil Hagelberg3
The NewSignup method was already being called with requireApproval=false, but it had emailVerified=false as well, which meant that it was required to use the `admin account confirm` command to verify the email before the newly-created user could log in. I think that was probably an oversight; effectively it did require approval anyway. Changing emailVerified to true allows you to just create the account and log in immediately, reducing the opportunity for manual error to sneak in. Also updated the docs to remove the mention of needing to confirm new accounts. However, I've left the confirmation command alone because I think once we have web signups, it will be needed in that context.
2022-11-24[feature] `PATCH /api/v1/admin/custom_emojis/{id}` endpoint (#1061)Libravatar tobi1
* start adding admin emoji PATCH stuff * updating works OK, now how about copying * allow emojis to be copied * update swagger docs * update admin processer to use non-interface storage driver * remove shortcode updating for local emojis * go fmt Co-authored-by: f0x52 <f0x@cthu.lu>
2022-11-23[docs] Clarify that reverse proxy setups need trusted-proxies (#1127)Libravatar dx4
* [docs] Clarify that reverse proxy setups need trusted-proxies * Remove the jq usage
2022-11-22[docs] Document http/s/socks5 proxy use (#1118)Libravatar tobi1
2022-11-21[docs] Add first draft of FAQ (#1086)Libravatar Phil Hagelberg2
* Clarify that gotosocial doesn't use recommendation algorithms It uses lots of algorithms. ~/src/gotosocial $ rgrep algorithm . | wc 856 8971 143395 * Add first draft of the FAQ. * Suggested FAQ changes. Mention backfill of posts as not yet being implemented; link to FAQ from readme/index. Mention that GtS does serve up some UI; just not most interaction.
2022-11-19[feature] Support markdown format for Account bio/note (#1037)Libravatar Michael Manfre2
* [feature] Status format also controls bio format * test
2022-11-19[docs] Move and document logs (#1076)Libravatar Leonora Tindall1
Rather than a single access log and no error logging, put the logs in /var/log/gotosocial/, and document creating and owning that directory
2022-11-19[docs] Remove trailing / from proxy_pass for nginx (#1077)Libravatar Leonora Tindall1
The trailing / can break relative URLs.
2022-11-17[docs] Add AUR Reference (#1054)Libravatar Jelle van der Waa1
The AUR is the Arch unofficial repository, where users can upload PKGBUILD's for Arch Linux users to build a package.
2022-11-17[docs] add account domain documentation (#1065)Libravatar tobi3
* [docs] add account domain documentation * add note about parent/subdomain
2022-11-17[docs] Update docker.md with docker tag / version stuff (#1067)Libravatar tobi1
2022-11-15[docs] Both HTTP proxies and NAT can cause rate limiting issues (#1053)Libravatar Phil Hagelberg1
Also explain specifically that setting the rate limit to zero turns off rate limiting rather than actually setting the limit to zero, since this is not intuitive.
2022-11-15[feature] Serialize local account role via API, and show it via web view (#1045)Libravatar tobi1
* [feature] Add 'role' field to api serialization of local accounts * [chore] Add a bit of license text while I'm here * [frogend] render account role on same line as username in web view of profile * style tweaking on role badges, general profile header layout * profile stats wrapping * don't render standard 'user' role on web view Co-authored-by: f0x <f0x@cthu.lu>
2022-11-14[feature] Allow newly uploaded emojis to be placed in categories (#939)Libravatar tobi1
* [feature] Add emoji categories GET Serialize emojis in appropriate categories; make it possible to get categories via the admin API * [feature] Create (or use existing) category for new emoji uploads * fix lint issue * update misleading line in swagger docs
2022-11-14[chore] Remove unused `admin account suspend` action (#1047)Libravatar tobi1
* [docs] clarify that admin account commands are for local accounts * [chore] remove confusing unused `admin account suspend` command
2022-11-14[feature] add instance-expose-public-timeline flag (#1039)Libravatar Rob Sargant1
* Add instance-expose-public-timeline flag Adds a config flag that allows unauthenticated access to /api/v1/timelines/public. Defaults to false to replicate existing behaviour. * Update structure following review * Add comment * Fix linting
2022-11-11[feature] S3: add config flag to proxy S3 media (#1014)Libravatar Mara Sophie Grosch1
* S3: add config value "proxy" for not redirecting Signed-off-by: Mara Sophie Grosch <littlefox@lf-net.org> * S3: document new config value "proxy" * S3: add new config value "proxy" to test scripts Signed-off-by: Mara Sophie Grosch <littlefox@lf-net.org>
2022-11-11[docs] postgres collation warning (#1017)Libravatar Lukáš Zapletal1
2022-11-10[docs] Replace old references to the previous streaming with websockets (#1015)Libravatar EchedeyLR1
2022-11-08[feature] Make instance thumbnail configurable via admin panel (#973)Libravatar tobi1
* [feature] Make instance thumbnail configurable via admin panel * log db errors in InstanceToAPIInstance * only update instance in db if necessary * start adding tests * finish test
2022-11-08[docs] add link to SELinux policy (#993)Libravatar Lukáš Zapletal1
2022-11-07[docs] refer to the latest release version (#992)Libravatar K1
2022-11-06[docs] add note about Alpha status right at the top (#971)Libravatar tobi1
2022-11-06[feature] Make rate limit requests amount configurable (#966)Libravatar tobi3
* update rate limit documentation * regenerate landingpage config helpers * make rate limit rate configurable
2022-11-01[docs] Update apache-httpd.md (#937)Libravatar EchedeyLR1
2022-10-31[docs] Change Apache SSL setup to automatic and manual mode (#936)Libravatar EchedeyLR1
* Update apache-httpd.md * Update apache-httpd.md * Update apache-httpd.md
2022-10-31[docs] Add Apache HTTP Server without LetsEncrypt (#935)Libravatar tobi1
2022-10-31[docs] Update Apache2 HTTP Server docs for websockets (#934)Libravatar tobi1
2022-10-31[docs] Update swagger.md (#933)Libravatar Mia Heidenstedt1
See https://github.com/superseriousbusiness/gotosocial/blob/main/internal/api/security/security.go ```go s.AttachMiddleware(m.RateLimit(RateLimitOptions{ // accept a maximum of 1000 requests in 5 minutes window Period: 5 * time.Minute, Limit: 1000, })) ```
2022-10-25[chore] update profile screenshot (#927)Libravatar f0x521
* update profile screenshot * optipng
2022-10-25FIx typo (#918)Libravatar mscherer1
2022-10-17[docs] Use correct form for status submit (#915)Libravatar tobi1
2022-10-14[feature] Add emoji DELETE handler at `/api/v1/admin/custom_emojis` (#913)Libravatar tobi1
* add emoji DELETE handler * no need to process error (thanks kim) * don't double check if user is admin * add missing security annotation
2022-10-13[feature] Add `/api/v1/admin/custom_emojis/{id}` endpoint for single emoji ↵Libravatar tobi1
GET (#910) * fix error in prev swagger docs * add GET for single admin emoji
2022-10-12[feature] Add `/api/v1/admin/custom_emojis` endpoint (#902)Libravatar tobi1
* add admin emojis get path + model + docs * stub admin emojis get processor function * add id + disabled fields to admin emoji * add emoji -> api admin emoji converter * tidy up a bit * add GetEmojis function * finish up get emojis function * order by shortcodedomain * ASC * tidy up + explain * update to allow paging * make admin emojis pageable * fix mixed case paging * normalize emoji queries a bit better * test emoji get paging * make limit optional * fix incorrect path in media cleanup tests * i have bad coder syndrome * don't trimspace * rename -> GetUseableEmojis * wrap emoji query in subquery avoid selecting more than we need * fix a bit of sillyness teehee * fix subquery postgres woes
2022-10-08[feature] Add opt-in RSS feed for account's latest Public posts (#897)Libravatar tobi3
* start adding rss functionality * add gorilla/feeds dependency * first bash at building rss feed still needs work, this is an interim commit * tidy up a bit * add publicOnly option to GetAccountLastPosted * implement rss endpoint * fix test * add initial user docs for rss * update rss logo * docs update * add rssFeed to frontend * feed -> feed.rss * enableRSS * increase rss logo size a lil bit * add rss toggle * move emojify to text package * fiddle with rss feed formatting * add Text field to test statuses * move status to rss item to typeconverter * update bun schema for enablerss * simplify 304 checking * assume account not rss * update tests * update swagger docs * allow more characters in title, trim nicer * update last posted to be more consistent