Compare commits
No commits in common. "main" and "v0.17.2" have entirely different histories.
228
.drone.yml
Normal file
|
|
@ -0,0 +1,228 @@
|
|||
---
|
||||
### Drone configuration file for GoToSocial.
|
||||
### Connects to https://drone.superseriousbusiness.org to perform testing, linting, and automatic builds/pushes to docker.
|
||||
###
|
||||
### For documentation on drone, see: https://docs.drone.io/
|
||||
### For documentation on drone docker pipelines in particular: https://docs.drone.io/pipeline/docker/overview/
|
||||
kind: pipeline
|
||||
type: docker
|
||||
name: default
|
||||
|
||||
steps:
|
||||
# We use golangci-lint for linting.
|
||||
# See: https://golangci-lint.run/
|
||||
- name: lint
|
||||
image: golangci/golangci-lint:v1.57.2
|
||||
volumes:
|
||||
- name: go-build-cache
|
||||
path: /root/.cache/go-build
|
||||
- name: golangci-lint-cache
|
||||
path: /root/.cache/golangci-lint
|
||||
- name: go-src
|
||||
path: /go
|
||||
commands:
|
||||
- golangci-lint run
|
||||
when:
|
||||
event:
|
||||
include:
|
||||
- pull_request
|
||||
|
||||
- name: test
|
||||
image: golang:1.22-alpine
|
||||
volumes:
|
||||
- name: go-build-cache
|
||||
path: /root/.cache/go-build
|
||||
- name: go-src
|
||||
path: /go
|
||||
- name: wazero-compilation-cache
|
||||
path: /root/.cache/wazero
|
||||
environment:
|
||||
CGO_ENABLED: "0"
|
||||
GTS_WAZERO_COMPILATION_CACHE: "/root/.cache/wazero"
|
||||
commands:
|
||||
- apk update --no-cache && apk add git
|
||||
- >-
|
||||
go test
|
||||
-failfast
|
||||
-timeout=20m
|
||||
-tags "netgo osusergo static_build kvformat timetzdata"
|
||||
./...
|
||||
- ./test/envparsing.sh
|
||||
- ./test/swagger.sh
|
||||
depends_on:
|
||||
- lint
|
||||
when:
|
||||
event:
|
||||
include:
|
||||
- pull_request
|
||||
|
||||
- name: web-setup
|
||||
image: node:18-alpine
|
||||
volumes:
|
||||
- name: yarn_cache
|
||||
path: /tmp/cache
|
||||
commands:
|
||||
- yarn --cwd ./web/source install --frozen-lockfile --cache-folder /tmp/cache
|
||||
- yarn --cwd ./web/source ts-patch install # https://typia.io/docs/setup/#manual-setup
|
||||
depends_on:
|
||||
- test
|
||||
when:
|
||||
event:
|
||||
include:
|
||||
- pull_request
|
||||
|
||||
- name: web-lint
|
||||
image: node:18-alpine
|
||||
commands:
|
||||
- yarn --cwd ./web/source lint
|
||||
depends_on:
|
||||
- web-setup
|
||||
when:
|
||||
event:
|
||||
include:
|
||||
- pull_request
|
||||
|
||||
- name: web-build
|
||||
image: node:18-alpine
|
||||
commands:
|
||||
- yarn --cwd ./web/source build
|
||||
depends_on:
|
||||
- web-setup
|
||||
when:
|
||||
event:
|
||||
include:
|
||||
- pull_request
|
||||
|
||||
- name: snapshot
|
||||
image: superseriousbusiness/gotosocial-drone-build:0.6.2 # https://github.com/superseriousbusiness/gotosocial-drone-build
|
||||
volumes:
|
||||
- name: go-build-cache
|
||||
path: /root/.cache/go-build
|
||||
- name: docker
|
||||
path: /var/run/docker.sock
|
||||
environment:
|
||||
DOCKER_USERNAME: gotosocial
|
||||
DOCKER_PASSWORD:
|
||||
from_secret: gts_docker_password
|
||||
S3_ACCESS_KEY_ID:
|
||||
from_secret: gts_s3_access_key_id
|
||||
S3_SECRET_ACCESS_KEY:
|
||||
from_secret: gts_s3_secret_access_key
|
||||
S3_HOSTNAME: "https://s3.superseriousbusiness.org"
|
||||
S3_BUCKET_NAME: "gotosocial-snapshots"
|
||||
commands:
|
||||
# Create a snapshot build with GoReleaser.
|
||||
- git fetch --tags
|
||||
- goreleaser release --clean --snapshot
|
||||
|
||||
# Login to Docker, push Docker image snapshots + manifests.
|
||||
- /go/dockerlogin.sh
|
||||
- docker push superseriousbusiness/gotosocial:snapshot-armv6
|
||||
- docker push superseriousbusiness/gotosocial:snapshot-armv7
|
||||
- docker push superseriousbusiness/gotosocial:snapshot-arm64v8
|
||||
- docker push superseriousbusiness/gotosocial:snapshot-amd64
|
||||
- docker manifest create superseriousbusiness/gotosocial:snapshot superseriousbusiness/gotosocial:snapshot-armv6 superseriousbusiness/gotosocial:snapshot-armv7 superseriousbusiness/gotosocial:snapshot-amd64 superseriousbusiness/gotosocial:snapshot-arm64v8
|
||||
- docker manifest push superseriousbusiness/gotosocial:snapshot
|
||||
- docker push superseriousbusiness/gotosocial:snapshot-armv6-moderncsqlite
|
||||
- docker push superseriousbusiness/gotosocial:snapshot-armv7-moderncsqlite
|
||||
- docker push superseriousbusiness/gotosocial:snapshot-arm64v8-moderncsqlite
|
||||
- docker push superseriousbusiness/gotosocial:snapshot-amd64-moderncsqlite
|
||||
- docker manifest create superseriousbusiness/gotosocial:snapshot-moderncsqlite superseriousbusiness/gotosocial:snapshot-armv6-moderncsqlite superseriousbusiness/gotosocial:snapshot-armv7-moderncsqlite superseriousbusiness/gotosocial:snapshot-amd64-moderncsqlite superseriousbusiness/gotosocial:snapshot-arm64v8-moderncsqlite
|
||||
- docker manifest push superseriousbusiness/gotosocial:snapshot-moderncsqlite
|
||||
|
||||
# Publish binary .tar.gz snapshots to S3.
|
||||
- /go/snapshot_publish.sh
|
||||
when:
|
||||
event:
|
||||
include:
|
||||
- push
|
||||
branch:
|
||||
include:
|
||||
- main
|
||||
|
||||
- name: release
|
||||
image: superseriousbusiness/gotosocial-drone-build:0.6.2 # https://github.com/superseriousbusiness/gotosocial-drone-build
|
||||
volumes:
|
||||
- name: go-build-cache
|
||||
path: /root/.cache/go-build
|
||||
- name: docker
|
||||
path: /var/run/docker.sock
|
||||
environment:
|
||||
DOCKER_USERNAME: gotosocial
|
||||
DOCKER_PASSWORD:
|
||||
from_secret: gts_docker_password
|
||||
GITHUB_TOKEN:
|
||||
from_secret: github_token
|
||||
commands:
|
||||
- git fetch --tags
|
||||
- /go/dockerlogin.sh
|
||||
|
||||
# When releasing, compare commits to the most recent tag that is not the
|
||||
# current one AND is not a release candidate tag (ie., no "rc" in the name).
|
||||
#
|
||||
# The DRONE_TAG env var should point to the tag that triggered this build.
|
||||
# See: https://docs.drone.io/pipeline/environment/reference/drone-tag/
|
||||
#
|
||||
# Note, this may cause annoyances when doing backport releases, for example,
|
||||
# releasing v0.10.1 when we've already released v0.15.0 or whatever, but
|
||||
# they should only be superficial annoyances related to the release notes.
|
||||
- GORELEASER_PREVIOUS_TAG=$(git tag -l | grep -v "rc\|${DRONE_TAG}" | sort -V -r | head -n 1) goreleaser release --clean
|
||||
when:
|
||||
event:
|
||||
include:
|
||||
- tag
|
||||
|
||||
# We can speed up builds significantly by caching build artifacts between runs.
|
||||
# See: https://docs.drone.io/pipeline/docker/syntax/volumes/host/
|
||||
volumes:
|
||||
- name: go-build-cache
|
||||
host:
|
||||
path: /drone/gotosocial/go-build
|
||||
- name: golangci-lint-cache
|
||||
host:
|
||||
path: /drone/gotosocial/golangci-lint
|
||||
- name: go-src
|
||||
host:
|
||||
path: /drone/gotosocial/go
|
||||
- name: docker
|
||||
host:
|
||||
path: /var/run/docker.sock
|
||||
|
||||
trigger:
|
||||
repo:
|
||||
- superseriousbusiness/gotosocial
|
||||
- NyaaaWhatsUpDoc/gotosocial
|
||||
- f0x52/gotosocial
|
||||
|
||||
---
|
||||
kind: pipeline
|
||||
type: docker
|
||||
name: cron
|
||||
|
||||
trigger:
|
||||
event:
|
||||
- cron
|
||||
cron:
|
||||
- nightly
|
||||
|
||||
clone:
|
||||
disable: true
|
||||
|
||||
steps:
|
||||
- name: mirror
|
||||
image: superseriousbusiness/gotosocial-drone-build:0.6.2
|
||||
environment:
|
||||
ORIGIN_REPO: https://github.com/superseriousbusiness/gotosocial
|
||||
TARGET_REPO: https://codeberg.org/superseriousbusiness/gotosocial
|
||||
CODEBERG_USER: gotosocialbot
|
||||
CODEBERG_EMAIL: admin@gotosocial.org
|
||||
CODEBERG_TOKEN:
|
||||
from_secret: gts_codeberg_token
|
||||
commands:
|
||||
- /go/codeberg_clone.sh
|
||||
|
||||
---
|
||||
kind: signature
|
||||
hmac: 1b89e3a538fbca72eb9a0b398cd82f09a774ba3649013e19d36012eda327e83f
|
||||
|
||||
...
|
||||
|
|
@ -1,76 +0,0 @@
|
|||
name: Bug Report
|
||||
description: Create a report to help us improve
|
||||
title: "[bug] Issue Title"
|
||||
labels: [bug]
|
||||
assignees: []
|
||||
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Thanks for taking the time to fill out this bug report! Please be cautious with the sensitive information/logs while filing the issue.
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
⚠️ If you're reporting an interoperability issue with a **closed source**
|
||||
ActivityPub/Mastodon client or server, please report the issue to the
|
||||
developers of that client or server instead. Without access to their
|
||||
source debugging the issue is difficult for us. Since GoToSocial is
|
||||
open source, developers of closed source implementations can run a copy
|
||||
and autonomously debug the issue. We'll gladly address any bugs they
|
||||
raise with us.
|
||||
- type: textarea
|
||||
id: desc
|
||||
attributes:
|
||||
label: Describe the bug with a clear and concise description of what the bug is.
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: input
|
||||
id: GoToSocial-Version
|
||||
attributes:
|
||||
label: What's your GoToSocial Version?
|
||||
description: Enter the Version of your GoToSocial Installation
|
||||
placeholder: e.g. v0.3.4
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: input
|
||||
id: GoToSocial-Arch
|
||||
attributes:
|
||||
label: GoToSocial Arch
|
||||
description: What architecture do you use and did you do a Binary or Docker installation?
|
||||
placeholder: e.g. arm64 Docker or arm64 Binary
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: textarea
|
||||
id: what-happened
|
||||
attributes:
|
||||
label: What happened?
|
||||
description: Enter exactly what happened.
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: textarea
|
||||
id: what-expected
|
||||
attributes:
|
||||
label: What you expected to happen?
|
||||
description: Enter what you expected to happen.
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: textarea
|
||||
id: how-to-reproduce
|
||||
attributes:
|
||||
label: How to reproduce it?
|
||||
description: As minimally and precisely as possible.
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: textarea
|
||||
id: anything-else
|
||||
attributes:
|
||||
label: Anything else we need to know?
|
||||
validations:
|
||||
required: false
|
||||
|
|
@ -1 +0,0 @@
|
|||
blank_issues_enabled: false
|
||||
|
|
@ -1,44 +0,0 @@
|
|||
name: Feature request
|
||||
description: Suggest an idea for this project
|
||||
title: "[feature] Issue Title"
|
||||
labels: [enhancement]
|
||||
assignees:
|
||||
-
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Thanks for taking the time to fill out this feature request!
|
||||
|
||||
- type: textarea
|
||||
id: desc
|
||||
attributes:
|
||||
label: Is your feature request related to a problem ?
|
||||
description: Give a clear and concise description of what the problem is.
|
||||
placeholder: ex. I'm always frustrated when [...]
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: prop-solution
|
||||
attributes:
|
||||
label: Describe the solution you'd like.
|
||||
description: A clear and concise description of what you want to happen.
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: alternatives
|
||||
attributes:
|
||||
label: Describe alternatives you've considered.
|
||||
description: A clear and concise description of any alternative solutions or features you've considered. If nothing, please enter `NONE`
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: additional-ctxt
|
||||
attributes:
|
||||
label: Additional context.
|
||||
description: Add any other context or screenshots about the feature request here.
|
||||
validations:
|
||||
required: false
|
||||
|
|
@ -1,67 +0,0 @@
|
|||
name: Frontend Bug Report
|
||||
description: Report an issue related to the web frontend
|
||||
title: "[bug/frontend] Issue Title"
|
||||
labels: ["bug", "frontend"]
|
||||
assignees: []
|
||||
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Thanks for taking the time to fill out this bug report! Please be cautious with the sensitive information/logs while filing the issue.
|
||||
|
||||
- type: textarea
|
||||
id: desc
|
||||
attributes:
|
||||
label: Describe the bug with a clear and concise description of what the bug is. Please include screenshots of any visual issues.
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: input
|
||||
id: GoToSocial-Version
|
||||
attributes:
|
||||
label: What's your GoToSocial Version?
|
||||
description: Enter the Version of your GoToSocial Installation
|
||||
placeholder: e.g. v0.3.4
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: input
|
||||
id: Browser-Version
|
||||
attributes:
|
||||
label: Browser version
|
||||
description: What browser(s) and versions are you using that show this bug?
|
||||
placeholder: Firefox 103.0b9 (64-bit)
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: what-happened
|
||||
attributes:
|
||||
label: What happened?
|
||||
description: Enter exactly what happened.
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: textarea
|
||||
id: what-expected
|
||||
attributes:
|
||||
label: What you expected to happen?
|
||||
description: Enter what you expected to happen.
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: textarea
|
||||
id: how-to-reproduce
|
||||
attributes:
|
||||
label: How to reproduce it?
|
||||
description: As minimally and precisely as possible.
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: textarea
|
||||
id: anything-else
|
||||
attributes:
|
||||
label: Anything else we need to know?
|
||||
validations:
|
||||
required: false
|
||||
|
|
@ -1,6 +0,0 @@
|
|||
---
|
||||
name: Other
|
||||
about: A different type of issue or question.
|
||||
labels:
|
||||
- question
|
||||
---
|
||||
2
.github/FUNDING.yml
vendored
Normal file
|
|
@ -0,0 +1,2 @@
|
|||
open_collective: gotosocial
|
||||
liberapay: GoToSocial
|
||||
67
.github/ISSUE_TEMPLATE/bug_frontend.yaml
vendored
Normal file
|
|
@ -0,0 +1,67 @@
|
|||
name: Frontend Bug Report
|
||||
description: Report an issue related to the web frontend
|
||||
title: "[bug] Issue Title"
|
||||
labels: ["bug", "frontend"]
|
||||
assignees: []
|
||||
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Thanks for taking the time to fill out this bug report! Please be cautious with the sensitive information/logs while filing the issue.
|
||||
|
||||
- type: textarea
|
||||
id: desc
|
||||
attributes:
|
||||
label: Describe the bug with a clear and concise description of what the bug is. Please include screenshots of any visual issues.
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: input
|
||||
id: GoToSocial-Version
|
||||
attributes:
|
||||
label: What's your GoToSocial Version?
|
||||
description: Enter the Version of your GoToSocial Installation
|
||||
placeholder: e.g. v0.3.4
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: input
|
||||
id: Browser-Version
|
||||
attributes:
|
||||
label: Browser version
|
||||
description: What browser(s) and versions are you using that show this bug?
|
||||
placeholder: Firefox 103.0b9 (64-bit)
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: what-happened
|
||||
attributes:
|
||||
label: What happened?
|
||||
description: Enter exactly what happened.
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: textarea
|
||||
id: what-expected
|
||||
attributes:
|
||||
label: What you expected to happen?
|
||||
description: Enter what you expected to happen.
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: textarea
|
||||
id: how-to-reproduce
|
||||
attributes:
|
||||
label: How to reproduce it?
|
||||
description: As minimally and precisely as possible.
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: textarea
|
||||
id: anything-else
|
||||
attributes:
|
||||
label: Anything else we need to know?
|
||||
validations:
|
||||
required: false
|
||||
76
.github/ISSUE_TEMPLATE/bug_report.yaml
vendored
Normal file
|
|
@ -0,0 +1,76 @@
|
|||
name: Bug Report
|
||||
description: Create a report to help us improve
|
||||
title: "[bug] Issue Title"
|
||||
labels: [bug]
|
||||
assignees: []
|
||||
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Thanks for taking the time to fill out this bug report! Please be cautious with the sensitive information/logs while filing the issue.
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
⚠️ If you're reporting an interoperability issue with a **closed source**
|
||||
ActivityPub/Mastodon client or server, please report the issue to the
|
||||
developers of that client or server instead. Without access to their
|
||||
source debugging the issue is difficult for us. Since GoToSocial is
|
||||
open source, developers of closed source implementations can run a copy
|
||||
and autonomously debug the issue. We'll gladly address any bugs they
|
||||
raise with us.
|
||||
- type: textarea
|
||||
id: desc
|
||||
attributes:
|
||||
label: Describe the bug with a clear and concise description of what the bug is.
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: input
|
||||
id: GoToSocial-Version
|
||||
attributes:
|
||||
label: What's your GoToSocial Version?
|
||||
description: Enter the Version of your GoToSocial Installation
|
||||
placeholder: e.g. v0.3.4
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: input
|
||||
id: GoToSocial-Arch
|
||||
attributes:
|
||||
label: GoToSocial Arch
|
||||
description: What architecture do you use and did you do a Binary or Docker installation?
|
||||
placeholder: e.g. arm64 Docker or arm64 Binary
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: textarea
|
||||
id: what-happened
|
||||
attributes:
|
||||
label: What happened?
|
||||
description: Enter exactly what happened.
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: textarea
|
||||
id: what-expected
|
||||
attributes:
|
||||
label: What you expected to happen?
|
||||
description: Enter what you expected to happen.
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: textarea
|
||||
id: how-to-reproduce
|
||||
attributes:
|
||||
label: How to reproduce it?
|
||||
description: As minimally and precisely as possible.
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: textarea
|
||||
id: anything-else
|
||||
attributes:
|
||||
label: Anything else we need to know?
|
||||
validations:
|
||||
required: false
|
||||
8
.github/ISSUE_TEMPLATE/custom.md
vendored
Normal file
|
|
@ -0,0 +1,8 @@
|
|||
---
|
||||
name: Custom issue template
|
||||
about: Describe this issue template's purpose here.
|
||||
title: ''
|
||||
labels: ''
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
44
.github/ISSUE_TEMPLATE/feature_request.yaml
vendored
Normal file
|
|
@ -0,0 +1,44 @@
|
|||
name: Feature request
|
||||
description: Suggest an idea for this project
|
||||
title: "[feature] Issue Title"
|
||||
labels: [enhancement]
|
||||
assignees:
|
||||
-
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Thanks for taking the time to fill out this feature request!
|
||||
|
||||
- type: textarea
|
||||
id: desc
|
||||
attributes:
|
||||
label: Is your feature request related to a problem ?
|
||||
description: Give a clear and concise description of what the problem is.
|
||||
placeholder: ex. I'm always frustrated when [...]
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: prop-solution
|
||||
attributes:
|
||||
label: Describe the solution you'd like.
|
||||
description: A clear and concise description of what you want to happen.
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: alternatives
|
||||
attributes:
|
||||
label: Describe alternatives you've considered.
|
||||
description: A clear and concise description of any alternative solutions or features you've considered. If nothing, please enter `NONE`
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: additional-ctxt
|
||||
attributes:
|
||||
label: Additional context.
|
||||
description: Add any other context or screenshots about the feature request here.
|
||||
validations:
|
||||
required: false
|
||||
5
.github/README.md
vendored
|
|
@ -1,5 +0,0 @@
|
|||
# GoToSocial
|
||||
|
||||
This is a mirror. You can find us on https://codeberg.org/superseriousbusiness/gotosocial.
|
||||
|
||||
We will **stop mirroring** to Github after 0.20 is released. This will likely be sometime **in August**.
|
||||
15
.github/dependabot.yml
vendored
Normal file
|
|
@ -0,0 +1,15 @@
|
|||
# To get started with Dependabot version updates, you'll need to specify which
|
||||
# package ecosystems to update and where the package manifests are located.
|
||||
# Please see the documentation for all configuration options:
|
||||
# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
|
||||
|
||||
version: 2
|
||||
updates:
|
||||
- package-ecosystem: "gomod" # See documentation for possible values
|
||||
directory: "/" # Location of package manifests
|
||||
schedule:
|
||||
interval: "weekly"
|
||||
commit-message:
|
||||
prefix: "[chore]"
|
||||
labels:
|
||||
- "chore"
|
||||
|
|
@ -15,7 +15,7 @@ Please put an x inside each checkbox to indicate that you've read and followed i
|
|||
|
||||
If this is a documentation change, only the first checkbox must be filled (you can delete the others if you want).
|
||||
|
||||
- [ ] I/we have read the [GoToSocial contribution guidelines](https://codeberg.org/superseriousbusiness/gotosocial/src/branch/main/CONTRIBUTING.md).
|
||||
- [ ] I/we have read the [GoToSocial contribution guidelines](https://github.com/superseriousbusiness/gotosocial/blob/main/CONTRIBUTING.md).
|
||||
- [ ] I/we have discussed the proposed changes already, either in an issue on the repository, or in the Matrix chat.
|
||||
- [ ] I/we have not leveraged AI to create the proposed changes.
|
||||
- [ ] I/we have performed a self-review of added code.
|
||||
30
.github/workflows/autoclose.yaml
vendored
|
|
@ -1,30 +0,0 @@
|
|||
on:
|
||||
issues:
|
||||
types: [opened]
|
||||
pull_request_target:
|
||||
types: [opened]
|
||||
|
||||
permissions:
|
||||
issues: write
|
||||
pull-requests: write
|
||||
|
||||
jobs:
|
||||
autoclose:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: issue
|
||||
if: ${{ github.event.issue.id != '' }}
|
||||
run: |
|
||||
gh issue close $ISSUE --comment "This repository is a mirror. Please open issues on https://codeberg.org/superseriousbusiness/gotosocial." --reason "not planned"
|
||||
gh issue lock $ISSUE
|
||||
env:
|
||||
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
ISSUE: ${{ github.event.issue.html_url }}
|
||||
- name: pr
|
||||
if: ${{ github.event.pull_request.id != '' }}
|
||||
run: |
|
||||
gh pr close $PULL_REQUEST --comment "This repository is a mirror. Please open PRs on https://codeberg.org/superseriousbusiness/gotosocial."
|
||||
gh pr lock $PULL_REQUEST
|
||||
env:
|
||||
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
PULL_REQUEST: ${{ github.event.pull_request.html_url }}
|
||||
7
.gitignore
vendored
|
|
@ -4,10 +4,6 @@
|
|||
# exclude built documentation, since readthedocs will build it for us anyway
|
||||
/docs/_build
|
||||
|
||||
# exclude kim's commonly used
|
||||
# test stdout file location
|
||||
test.out
|
||||
|
||||
# exclude coverage report
|
||||
cp.out
|
||||
|
||||
|
|
@ -23,9 +19,6 @@ dist/
|
|||
# exclude the copy of swagger.yaml moved into assets during packaging
|
||||
web/assets/swagger.yaml
|
||||
|
||||
# exclude the copy of all_licenses.txt moved into assets during packaging
|
||||
web/assets/all_licenses.txt
|
||||
|
||||
# exludes docker-volume from exemple/docker-compose
|
||||
example/docker-compose/docker-volume
|
||||
|
||||
|
|
|
|||
151
.golangci.yml
|
|
@ -4,98 +4,91 @@
|
|||
#
|
||||
# For GoToSocial we mostly take the default linters, but we add a few to catch style issues as well.
|
||||
|
||||
version: "2"
|
||||
# options for analysis running
|
||||
run:
|
||||
# include test files or not, default is true
|
||||
tests: false
|
||||
# timeout for analysis, e.g. 30s, 5m, default is 1m
|
||||
timeout: 5m
|
||||
|
||||
linters:
|
||||
# enable some extra linters, see here for the list: https://golangci-lint.run/usage/linters/
|
||||
enable:
|
||||
- gocritic
|
||||
- gofmt
|
||||
- goheader
|
||||
- gosec
|
||||
- nilerr
|
||||
- revive
|
||||
# https://golangci-lint.run/usage/linters/#linters-configuration
|
||||
settings:
|
||||
# https://golangci-lint.run/usage/linters/#goheader
|
||||
goheader:
|
||||
template: |-
|
||||
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.
|
||||
# https://golangci-lint.run/usage/linters/#linters-configuration
|
||||
linters-settings:
|
||||
# https://golangci-lint.run/usage/linters/#goheader
|
||||
goheader:
|
||||
template: |-
|
||||
GoToSocial
|
||||
Copyright (C) GoToSocial Authors admin@gotosocial.org
|
||||
SPDX-License-Identifier: AGPL-3.0-or-later
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
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/>.
|
||||
# https://golangci-lint.run/usage/linters/#govet
|
||||
govet:
|
||||
disable:
|
||||
- composites
|
||||
# https://golangci-lint.run/usage/linters/#revive
|
||||
revive:
|
||||
rules:
|
||||
# Enable most default rules.
|
||||
# See: https://github.com/mgechev/revive/blob/master/defaults.toml
|
||||
- name: blank-imports
|
||||
- name: context-as-argument
|
||||
- name: context-keys-type
|
||||
- name: dot-imports
|
||||
- name: error-naming
|
||||
- name: error-return
|
||||
- name: error-strings
|
||||
- name: exported
|
||||
- name: if-return
|
||||
- name: increment-decrement
|
||||
- name: var-naming
|
||||
- name: var-declaration
|
||||
- name: package-comments
|
||||
- name: range
|
||||
- name: receiver-naming
|
||||
- name: time-naming
|
||||
- name: unexported-return
|
||||
- name: indent-error-flow
|
||||
- name: errorf
|
||||
- name: empty-block
|
||||
- name: superfluous-else
|
||||
- name: unreachable-code
|
||||
# Disable below rules.
|
||||
- name: redefines-builtin-id
|
||||
disabled: true
|
||||
- name: unused-parameter
|
||||
disabled: true
|
||||
- name: var-naming
|
||||
arguments:
|
||||
- []
|
||||
- []
|
||||
- - skip-package-name-checks: true
|
||||
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.
|
||||
|
||||
# https://golangci-lint.run/usage/linters/#staticcheck
|
||||
staticcheck:
|
||||
# Enable all checks, but disable SA1012: nil context passing.
|
||||
# See: https://staticcheck.io/docs/configuration/options/#checks
|
||||
checks:
|
||||
- SA*
|
||||
- -SA1012
|
||||
exclusions:
|
||||
generated: lax
|
||||
presets:
|
||||
- comments
|
||||
- common-false-positives
|
||||
- legacy
|
||||
- std-error-handling
|
||||
formatters:
|
||||
enable:
|
||||
- gofmt
|
||||
exclusions:
|
||||
generated: lax
|
||||
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/>.
|
||||
# https://golangci-lint.run/usage/linters/#govet
|
||||
govet:
|
||||
disable:
|
||||
- composites
|
||||
# https://golangci-lint.run/usage/linters/#revive
|
||||
revive:
|
||||
rules:
|
||||
# Enable most default rules.
|
||||
# See: https://github.com/mgechev/revive/blob/master/defaults.toml
|
||||
- name: blank-imports
|
||||
- name: context-as-argument
|
||||
- name: context-keys-type
|
||||
- name: dot-imports
|
||||
- name: error-naming
|
||||
- name: error-return
|
||||
- name: error-strings
|
||||
- name: exported
|
||||
- name: if-return
|
||||
- name: increment-decrement
|
||||
- name: var-naming
|
||||
- name: var-declaration
|
||||
- name: package-comments
|
||||
- name: range
|
||||
- name: receiver-naming
|
||||
- name: time-naming
|
||||
- name: unexported-return
|
||||
- name: indent-error-flow
|
||||
- name: errorf
|
||||
- name: empty-block
|
||||
- name: superfluous-else
|
||||
- name: unreachable-code
|
||||
# Disable below rules.
|
||||
- name: redefines-builtin-id
|
||||
disabled: true # This one is just annoying.
|
||||
- name: unused-parameter
|
||||
disabled: true # We often pass parameters to fulfil interfaces.
|
||||
# https://golangci-lint.run/usage/linters/#staticcheck
|
||||
staticcheck:
|
||||
# Enable all checks, but disable SA1012: nil context passing.
|
||||
# See: https://staticcheck.io/docs/configuration/options/#checks
|
||||
checks: ["all", "-SA1012"]
|
||||
|
||||
issues:
|
||||
exclude-rules:
|
||||
# Exclude VSCode custom folding region comments in files that use them.
|
||||
# Already fixed in go-critic and can be removed next time go-critic is updated.
|
||||
- linters:
|
||||
- gocritic
|
||||
path: internal/db/filter.go
|
||||
text: 'commentFormatting: put a space between `//` and comment text'
|
||||
|
|
|
|||
328
.goreleaser.yml
|
|
@ -1,28 +1,21 @@
|
|||
# Version 2 of GoReleaser: https://goreleaser.com/errors/version/
|
||||
version: 2
|
||||
# https://goreleaser.com
|
||||
project_name: gotosocial
|
||||
|
||||
# https://goreleaser.com/scm/gitea/#urls
|
||||
gitea_urls:
|
||||
api: https://codeberg.org/api/v1
|
||||
download: https://codeberg.org
|
||||
version: 2
|
||||
|
||||
# https://goreleaser.com/customization/hooks/
|
||||
before:
|
||||
hooks:
|
||||
# generate the swagger.yaml file using go-swagger and bundle it into the assets directory
|
||||
- go run ./vendor/github.com/go-swagger/go-swagger/cmd/swagger generate spec --scan-models --exclude-deps -o web/assets/swagger.yaml
|
||||
- swagger generate spec --scan-models --exclude-deps -o web/assets/swagger.yaml
|
||||
- sed -i "s/REPLACE_ME/{{ incpatch .Version }}/" web/assets/swagger.yaml
|
||||
# Install web deps + bundle web assets
|
||||
- yarn --cwd ./web/source install
|
||||
- yarn --cwd ./web/source ts-patch install # https://typia.io/docs/setup/#manual-setup
|
||||
- yarn --cwd ./web/source build
|
||||
# Bundle all licenses into web/assets/all_licenses.txt
|
||||
- ./scripts/bundle_licenses.sh
|
||||
|
||||
# https://goreleaser.com/customization/build/
|
||||
builds:
|
||||
# DEFAULT WASM BINARY BUILDS
|
||||
# DEFAULT WASM SQLITE BINARY BUILDS
|
||||
-
|
||||
id: gotosocial
|
||||
main: ./cmd/gotosocial
|
||||
|
|
@ -46,14 +39,27 @@ builds:
|
|||
goos:
|
||||
- linux
|
||||
- freebsd
|
||||
- netbsd
|
||||
goarch:
|
||||
- 386
|
||||
- amd64
|
||||
- arm
|
||||
- arm64
|
||||
goarm:
|
||||
- 6
|
||||
- 7
|
||||
ignore:
|
||||
# Build FreeBSD
|
||||
# only for amd64.
|
||||
- goos: freebsd
|
||||
goarch: arm64
|
||||
- goos: freebsd
|
||||
goarch: arm
|
||||
- goos: freebsd
|
||||
goarch: 386
|
||||
mod_timestamp: "{{ .CommitTimestamp }}"
|
||||
# NOWASM BINARY BUILDS
|
||||
# MODERNC SQLITE BINARY BUILDS
|
||||
-
|
||||
id: gotosocial_nowasm
|
||||
id: gotosocial_moderncsqlite
|
||||
main: ./cmd/gotosocial
|
||||
binary: gotosocial
|
||||
ldflags:
|
||||
|
|
@ -68,15 +74,12 @@ builds:
|
|||
- static_build
|
||||
- kvformat
|
||||
- timetzdata
|
||||
- nowasm
|
||||
- >-
|
||||
{{ if and (index .Env "DEBUG") (.Env.DEBUG) }}debugenv{{ end }}
|
||||
- moderncsqlite3
|
||||
env:
|
||||
- CGO_ENABLED=0
|
||||
goos:
|
||||
# moderncsqlite doesn't
|
||||
# build for netbsd right
|
||||
# now so leave it out.
|
||||
- linux
|
||||
- freebsd
|
||||
goarch:
|
||||
|
|
@ -88,8 +91,8 @@ builds:
|
|||
- 6
|
||||
- 7
|
||||
ignore:
|
||||
# Don't build BSDs
|
||||
# for arm/32-bit.
|
||||
# Build FreeBSD
|
||||
# only for amd64.
|
||||
- goos: freebsd
|
||||
goarch: arm64
|
||||
- goos: freebsd
|
||||
|
|
@ -100,7 +103,7 @@ builds:
|
|||
|
||||
# https://goreleaser.com/customization/docker/
|
||||
dockers:
|
||||
# DEFAULT WASM DOCKER BUILDS
|
||||
# DEFAULT WASM SQLITE DOCKER BUILDS
|
||||
-
|
||||
use: buildx
|
||||
goos: linux
|
||||
|
|
@ -109,21 +112,15 @@ dockers:
|
|||
ids:
|
||||
- gotosocial
|
||||
image_templates:
|
||||
- "{{ if not .IsSnapshot }}superseriousbusiness/{{ .ProjectName }}:{{ .Version }}-amd64{{ end }}" # Use version tag (eg., `0.19.0`, `0.19.0-rc1`) for proper releases and prereleases.
|
||||
- "{{ if and (not .Prerelease) (not .IsSnapshot) }}superseriousbusiness/{{ .ProjectName }}:latest-amd64{{ end }}" # Only use `latest` for proper releases, not prereleases or snapshots.
|
||||
- "{{ if .IsSnapshot }}superseriousbusiness/{{ .ProjectName }}:snapshot-amd64{{ end }}" # Only use `snapshot` for snapshot builds triggered by merge to main.
|
||||
- "superseriousbusiness/{{ .ProjectName }}:{{ .Version }}-amd64"
|
||||
- "superseriousbusiness/{{ .ProjectName }}:latest-amd64"
|
||||
- "{{ if .IsSnapshot }}superseriousbusiness/{{ .ProjectName }}:snapshot-amd64{{ end }}"
|
||||
build_flag_templates:
|
||||
- "--platform=linux/amd64"
|
||||
- "--label=org.opencontainers.image.title=GoToSocial"
|
||||
- "--label=org.opencontainers.image.authors=GoToSocial Authors"
|
||||
- "--label=org.opencontainers.image.description=Fast, fun, small ActivityPub server."
|
||||
- "--label=org.opencontainers.image.url=https://docs.gotosocial.org"
|
||||
- "--label=org.opencontainers.image.documentation=https://docs.gotosocial.org/en/latest/getting_started/installation/container/"
|
||||
- "--label=org.opencontainers.image.source=https://codeberg.org/superseriousbusiness/gotosocial"
|
||||
- "--label=org.opencontainers.image.version={{.Version}}"
|
||||
- "--label=org.opencontainers.image.revision={{.FullCommit}}"
|
||||
- "--label=org.opencontainers.image.created={{.Date}}"
|
||||
- "--label=org.opencontainers.image.licenses=AGPL-3.0-or-later"
|
||||
- "--label=org.opencontainers.image.title={{.ProjectName}}"
|
||||
- "--label=org.opencontainers.image.revision={{.FullCommit}}"
|
||||
- "--label=org.opencontainers.image.version={{.Version}}"
|
||||
extra_files:
|
||||
- web
|
||||
- go.mod
|
||||
|
|
@ -138,21 +135,158 @@ dockers:
|
|||
ids:
|
||||
- gotosocial
|
||||
image_templates:
|
||||
- "{{ if not .IsSnapshot }}superseriousbusiness/{{ .ProjectName }}:{{ .Version }}-arm64v8{{ end }}" # Use version tag (eg., `0.19.0`, `0.19.0-rc1`) for proper releases and prereleases.
|
||||
- "{{ if and (not .Prerelease) (not .IsSnapshot) }}superseriousbusiness/{{ .ProjectName }}:latest-arm64v8{{ end }}" # Only use `latest` for proper releases, not prereleases or snapshots.
|
||||
- "{{ if .IsSnapshot }}superseriousbusiness/{{ .ProjectName }}:snapshot-arm64v8{{ end }}" # Only use `snapshot` for snapshot builds triggered by merge to main.
|
||||
- "superseriousbusiness/{{ .ProjectName }}:{{ .Version }}-arm64v8"
|
||||
- "superseriousbusiness/{{ .ProjectName }}:latest-arm64v8"
|
||||
- "{{ if .IsSnapshot }}superseriousbusiness/{{ .ProjectName }}:snapshot-arm64v8{{ end }}"
|
||||
build_flag_templates:
|
||||
- "--platform=linux/arm64/v8"
|
||||
- "--label=org.opencontainers.image.title=GoToSocial"
|
||||
- "--label=org.opencontainers.image.authors=GoToSocial Authors"
|
||||
- "--label=org.opencontainers.image.description=Fast, fun, small ActivityPub server."
|
||||
- "--label=org.opencontainers.image.url=https://docs.gotosocial.org"
|
||||
- "--label=org.opencontainers.image.documentation=https://docs.gotosocial.org/en/latest/getting_started/installation/container/"
|
||||
- "--label=org.opencontainers.image.source=https://codeberg.org/superseriousbusiness/gotosocial"
|
||||
- "--label=org.opencontainers.image.version={{.Version}}"
|
||||
- "--label=org.opencontainers.image.revision={{.FullCommit}}"
|
||||
- "--label=org.opencontainers.image.created={{.Date}}"
|
||||
- "--label=org.opencontainers.image.licenses=AGPL-3.0-or-later"
|
||||
- "--label=org.opencontainers.image.title={{.ProjectName}}"
|
||||
- "--label=org.opencontainers.image.revision={{.FullCommit}}"
|
||||
- "--label=org.opencontainers.image.version={{.Version}}"
|
||||
extra_files:
|
||||
- web
|
||||
- go.mod
|
||||
- go.sum
|
||||
- cmd
|
||||
- internal
|
||||
-
|
||||
use: buildx
|
||||
goos: linux
|
||||
goarch: arm
|
||||
goarm: 6
|
||||
id: armv6
|
||||
ids:
|
||||
- gotosocial
|
||||
image_templates:
|
||||
- "superseriousbusiness/{{ .ProjectName }}:{{ .Version }}-armv6"
|
||||
- "superseriousbusiness/{{ .ProjectName }}:latest-armv6"
|
||||
- "{{ if .IsSnapshot }}superseriousbusiness/{{ .ProjectName }}:snapshot-armv6{{ end }}"
|
||||
build_flag_templates:
|
||||
- "--platform=linux/arm/v6"
|
||||
- "--label=org.opencontainers.image.created={{.Date}}"
|
||||
- "--label=org.opencontainers.image.title={{.ProjectName}}"
|
||||
- "--label=org.opencontainers.image.revision={{.FullCommit}}"
|
||||
- "--label=org.opencontainers.image.version={{.Version}}"
|
||||
extra_files:
|
||||
- web
|
||||
- go.mod
|
||||
- go.sum
|
||||
- cmd
|
||||
- internal
|
||||
-
|
||||
use: buildx
|
||||
goos: linux
|
||||
goarch: arm
|
||||
goarm: 7
|
||||
id: armv7
|
||||
ids:
|
||||
- gotosocial
|
||||
image_templates:
|
||||
- "superseriousbusiness/{{ .ProjectName }}:{{ .Version }}-armv7"
|
||||
- "superseriousbusiness/{{ .ProjectName }}:latest-armv7"
|
||||
- "{{ if .IsSnapshot }}superseriousbusiness/{{ .ProjectName }}:snapshot-armv7{{ end }}"
|
||||
build_flag_templates:
|
||||
- "--platform=linux/arm/v7"
|
||||
- "--label=org.opencontainers.image.created={{.Date}}"
|
||||
- "--label=org.opencontainers.image.title={{.ProjectName}}"
|
||||
- "--label=org.opencontainers.image.revision={{.FullCommit}}"
|
||||
- "--label=org.opencontainers.image.version={{.Version}}"
|
||||
extra_files:
|
||||
- web
|
||||
- go.mod
|
||||
- go.sum
|
||||
- cmd
|
||||
- internal
|
||||
# MODERNC SQLITE DOCKER BUILDS
|
||||
-
|
||||
use: buildx
|
||||
goos: linux
|
||||
goarch: amd64
|
||||
id: amd64-moderncsqlite
|
||||
ids:
|
||||
- gotosocial_moderncsqlite
|
||||
image_templates:
|
||||
- "superseriousbusiness/{{ .ProjectName }}:{{ .Version }}-amd64-moderncsqlite"
|
||||
- "superseriousbusiness/{{ .ProjectName }}:latest-amd64-moderncsqlite"
|
||||
- "{{ if .IsSnapshot }}superseriousbusiness/{{ .ProjectName }}:snapshot-amd64-moderncsqlite{{ end }}"
|
||||
build_flag_templates:
|
||||
- "--platform=linux/amd64"
|
||||
- "--label=org.opencontainers.image.created={{.Date}}"
|
||||
- "--label=org.opencontainers.image.title={{.ProjectName}}"
|
||||
- "--label=org.opencontainers.image.revision={{.FullCommit}}"
|
||||
- "--label=org.opencontainers.image.version={{.Version}}"
|
||||
extra_files:
|
||||
- web
|
||||
- go.mod
|
||||
- go.sum
|
||||
- cmd
|
||||
- internal
|
||||
-
|
||||
use: buildx
|
||||
goos: linux
|
||||
goarch: arm64
|
||||
id: arm64v8-moderncsqlite
|
||||
ids:
|
||||
- gotosocial_moderncsqlite
|
||||
image_templates:
|
||||
- "superseriousbusiness/{{ .ProjectName }}:{{ .Version }}-arm64v8-moderncsqlite"
|
||||
- "superseriousbusiness/{{ .ProjectName }}:latest-arm64v8-moderncsqlite"
|
||||
- "{{ if .IsSnapshot }}superseriousbusiness/{{ .ProjectName }}:snapshot-arm64v8-moderncsqlite{{ end }}"
|
||||
build_flag_templates:
|
||||
- "--platform=linux/arm64/v8"
|
||||
- "--label=org.opencontainers.image.created={{.Date}}"
|
||||
- "--label=org.opencontainers.image.title={{.ProjectName}}"
|
||||
- "--label=org.opencontainers.image.revision={{.FullCommit}}"
|
||||
- "--label=org.opencontainers.image.version={{.Version}}"
|
||||
extra_files:
|
||||
- web
|
||||
- go.mod
|
||||
- go.sum
|
||||
- cmd
|
||||
- internal
|
||||
-
|
||||
use: buildx
|
||||
goos: linux
|
||||
goarch: arm
|
||||
goarm: 6
|
||||
id: armv6-moderncsqlite
|
||||
ids:
|
||||
- gotosocial_moderncsqlite
|
||||
image_templates:
|
||||
- "superseriousbusiness/{{ .ProjectName }}:{{ .Version }}-armv6-moderncsqlite"
|
||||
- "superseriousbusiness/{{ .ProjectName }}:latest-armv6-moderncsqlite"
|
||||
- "{{ if .IsSnapshot }}superseriousbusiness/{{ .ProjectName }}:snapshot-armv6-moderncsqlite{{ end }}"
|
||||
build_flag_templates:
|
||||
- "--platform=linux/arm/v6"
|
||||
- "--label=org.opencontainers.image.created={{.Date}}"
|
||||
- "--label=org.opencontainers.image.title={{.ProjectName}}"
|
||||
- "--label=org.opencontainers.image.revision={{.FullCommit}}"
|
||||
- "--label=org.opencontainers.image.version={{.Version}}"
|
||||
extra_files:
|
||||
- web
|
||||
- go.mod
|
||||
- go.sum
|
||||
- cmd
|
||||
- internal
|
||||
-
|
||||
use: buildx
|
||||
goos: linux
|
||||
goarch: arm
|
||||
goarm: 7
|
||||
id: armv7-moderncsqlite
|
||||
ids:
|
||||
- gotosocial_moderncsqlite
|
||||
image_templates:
|
||||
- "superseriousbusiness/{{ .ProjectName }}:{{ .Version }}-armv7-moderncsqlite"
|
||||
- "superseriousbusiness/{{ .ProjectName }}:latest-armv7-moderncsqlite"
|
||||
- "{{ if .IsSnapshot }}superseriousbusiness/{{ .ProjectName }}:snapshot-armv7-moderncsqlite{{ end }}"
|
||||
build_flag_templates:
|
||||
- "--platform=linux/arm/v7"
|
||||
- "--label=org.opencontainers.image.created={{.Date}}"
|
||||
- "--label=org.opencontainers.image.title={{.ProjectName}}"
|
||||
- "--label=org.opencontainers.image.revision={{.FullCommit}}"
|
||||
- "--label=org.opencontainers.image.version={{.Version}}"
|
||||
extra_files:
|
||||
- web
|
||||
- go.mod
|
||||
|
|
@ -162,25 +296,48 @@ dockers:
|
|||
|
||||
# https://goreleaser.com/customization/docker_manifest/
|
||||
docker_manifests:
|
||||
# Use version tag (eg., `0.19.0`, `0.19.0-rc1`) for proper releases and prereleases.
|
||||
- name_template: "{{ if not .IsSnapshot }}superseriousbusiness/{{ .ProjectName }}:{{ .Version }}{{ end }}"
|
||||
# DEFAULT WASM SQLITE BUILDS
|
||||
- name_template: superseriousbusiness/{{ .ProjectName }}:{{ .Version }}
|
||||
image_templates:
|
||||
- superseriousbusiness/{{ .ProjectName }}:{{ .Version }}-amd64
|
||||
- superseriousbusiness/{{ .ProjectName }}:{{ .Version }}-arm64v8
|
||||
# Only use `latest` for proper releases, not prereleases or snapshots.
|
||||
- name_template: "{{ if and (not .Prerelease) (not .IsSnapshot) }}superseriousbusiness/{{ .ProjectName }}:latest{{ end }}"
|
||||
- superseriousbusiness/{{ .ProjectName }}:{{ .Version }}-armv6
|
||||
- superseriousbusiness/{{ .ProjectName }}:{{ .Version }}-armv7
|
||||
- name_template: superseriousbusiness/{{ .ProjectName }}:latest
|
||||
image_templates:
|
||||
- superseriousbusiness/{{ .ProjectName }}:latest-amd64
|
||||
- superseriousbusiness/{{ .ProjectName }}:latest-arm64v8
|
||||
# Only use `snapshot` for snapshot builds triggered by merge to main.
|
||||
- superseriousbusiness/{{ .ProjectName }}:latest-armv6
|
||||
- superseriousbusiness/{{ .ProjectName }}:latest-armv7
|
||||
- name_template: "{{ if .IsSnapshot }}superseriousbusiness/{{ .ProjectName }}:snapshot{{ end }}"
|
||||
image_templates:
|
||||
- superseriousbusiness/{{ .ProjectName }}:snapshot-amd64
|
||||
- superseriousbusiness/{{ .ProjectName }}:snapshot-arm64v8
|
||||
- superseriousbusiness/{{ .ProjectName }}:snapshot-armv6
|
||||
- superseriousbusiness/{{ .ProjectName }}:snapshot-armv7
|
||||
# MODERNC SQLITE BUILDS
|
||||
- name_template: superseriousbusiness/{{ .ProjectName }}:{{ .Version }}-moderncsqlite
|
||||
image_templates:
|
||||
- superseriousbusiness/{{ .ProjectName }}:{{ .Version }}-amd64-moderncsqlite
|
||||
- superseriousbusiness/{{ .ProjectName }}:{{ .Version }}-arm64v8-moderncsqlite
|
||||
- superseriousbusiness/{{ .ProjectName }}:{{ .Version }}-armv6-moderncsqlite
|
||||
- superseriousbusiness/{{ .ProjectName }}:{{ .Version }}-armv7-moderncsqlite
|
||||
- name_template: superseriousbusiness/{{ .ProjectName }}:latest-moderncsqlite
|
||||
image_templates:
|
||||
- superseriousbusiness/{{ .ProjectName }}:latest-amd64-moderncsqlite
|
||||
- superseriousbusiness/{{ .ProjectName }}:latest-arm64v8-moderncsqlite
|
||||
- superseriousbusiness/{{ .ProjectName }}:latest-armv6-moderncsqlite
|
||||
- superseriousbusiness/{{ .ProjectName }}:latest-armv7-moderncsqlite
|
||||
- name_template: "{{ if .IsSnapshot }}superseriousbusiness/{{ .ProjectName }}:snapshot-moderncsqlite{{ end }}"
|
||||
image_templates:
|
||||
- superseriousbusiness/{{ .ProjectName }}:snapshot-amd64-moderncsqlite
|
||||
- superseriousbusiness/{{ .ProjectName }}:snapshot-arm64v8-moderncsqlite
|
||||
- superseriousbusiness/{{ .ProjectName }}:snapshot-armv6-moderncsqlite
|
||||
- superseriousbusiness/{{ .ProjectName }}:snapshot-armv7-moderncsqlite
|
||||
|
||||
# https://goreleaser.com/customization/archive/
|
||||
archives:
|
||||
# DEFAULT WASM BUILD
|
||||
# DEFAULT WASM SQLITE BUILD
|
||||
-
|
||||
id: gotosocial
|
||||
builds:
|
||||
|
|
@ -197,11 +354,11 @@ archives:
|
|||
- example/config.yaml
|
||||
- example/gotosocial.service
|
||||
name_template: "{{ .ProjectName }}_{{ .Version }}_{{ .Os }}_{{ .Arch }}{{ with .Arm }}v{{ . }}{{ end }}{{ with .Mips }}_{{ . }}{{ end }}{{ if not (eq .Amd64 \"v1\") }}{{ .Amd64 }}{{ end }}"
|
||||
# NOWASM BUILD
|
||||
# MODERNC SQLITE BUILD
|
||||
-
|
||||
id: gotosocial_nowasm
|
||||
id: gotosocial_moderncsqlite
|
||||
builds:
|
||||
- gotosocial_nowasm
|
||||
- gotosocial_moderncsqlite
|
||||
files:
|
||||
# standard release files
|
||||
- LICENSE
|
||||
|
|
@ -213,7 +370,7 @@ archives:
|
|||
# example config files
|
||||
- example/config.yaml
|
||||
- example/gotosocial.service
|
||||
name_template: "{{ .ProjectName }}_{{ .Version }}_{{ .Os }}_{{ .Arch }}{{ with .Arm }}v{{ . }}{{ end }}{{ with .Mips }}_{{ . }}{{ end }}{{ if not (eq .Amd64 \"v1\") }}{{ .Amd64 }}{{ end }}_nowasm"
|
||||
name_template: "{{ .ProjectName }}_{{ .Version }}_{{ .Os }}_{{ .Arch }}{{ with .Arm }}v{{ . }}{{ end }}{{ with .Mips }}_{{ . }}{{ end }}{{ if not (eq .Amd64 \"v1\") }}{{ .Amd64 }}{{ end }}_moderncsqlite"
|
||||
-
|
||||
id: web-assets
|
||||
files:
|
||||
|
|
@ -239,10 +396,6 @@ source:
|
|||
|
||||
# https://goreleaser.com/customization/release/
|
||||
release:
|
||||
# https://goreleaser.com/customization/release/#gitea
|
||||
gitea:
|
||||
owner: superseriousbusiness
|
||||
name: gotosocial
|
||||
draft: true
|
||||
prerelease: auto
|
||||
header: |
|
||||
|
|
@ -265,8 +418,8 @@ release:
|
|||
#### Binary/tar
|
||||
|
||||
1. Stop GoToSocial.
|
||||
2. **Back up your database!** If you're running on SQLite, this is as simple as copying your `sqlite.db` file, eg., `cp sqlite.db sqlite.db.backup`. On Postgres you can do this with [pg_dump](https://www.postgresql.org/docs/current/backup-dump.html).
|
||||
3. Download and untar the new release, **including the web assets and html templates**, not just the binary.
|
||||
2. **Back up your database!** If you're running on SQLite, this is as simple as copying your `sqlite.db` file, eg., `cp sqlite.db sqlite.db.backup`.
|
||||
3. Download and untar the new release, including the web assets and html templates.
|
||||
4. Edit your config.yaml file if necessary (see below).
|
||||
5. Start GoToSocial.
|
||||
6. Wait patiently for any migrations to run, **do not interrupt migrations or you could leave your db in a broken state and will have to restore from backup**!
|
||||
|
|
@ -275,8 +428,8 @@ release:
|
|||
#### Docker
|
||||
|
||||
1. Stop GoToSocial.
|
||||
2. **Back up your database!** If you're running on SQLite, this is as simple as copying your `sqlite.db` file, eg., `cp sqlite.db sqlite.db.backup`. On Postgres you can do this with [pg_dump](https://www.postgresql.org/docs/current/backup-dump.html).
|
||||
3. Pull the new docker container with `docker pull docker.io/superseriousbusiness/gotosocial:{{ .Version }}` or `docker pull docker.io/superseriousbusiness/gotosocial:latest` if this is a stable release and not a release candidate.
|
||||
2. **Back up your database!** If you're running on SQLite, this is as simple as copying your `sqlite.db` file, eg., `cp sqlite.db sqlite.db.backup`.
|
||||
3. Pull the new docker container (`superseriousbusiness/gotosocial:{{ .Version }}` or `superseriousbusiness/gotosocial:latest`)
|
||||
4. Edit your config.yaml file or environment variables if necessary (see below).
|
||||
5. Start GoToSocial.
|
||||
6. Wait patiently for any migrations to run, **do not interrupt migrations or you could leave your db in a broken state and will have to restore from backup**!
|
||||
|
|
@ -289,7 +442,7 @@ release:
|
|||
- Changed `pee pee` to `poo poo`.
|
||||
- Changed `wee wee` to `more wee wee`.
|
||||
|
||||
You can see a diff of the config file here: https://codeberg.org/superseriousbusiness/gotosocial/compare/{{ .PreviousTag }}...{{ .Tag }}#diff-c071e03510b2c57e193a44503fd9528a785f0f411497cc75841a9f8d0b1ac622
|
||||
You can see a diff of the config file here: https://github.com/superseriousbusiness/gotosocial/compare/{{ .PreviousTag }}...{{ .Tag }}#diff-c071e03510b2c57e193a44503fd9528a785f0f411497cc75841a9f8d0b1ac622
|
||||
|
||||
### Database Migrations
|
||||
|
||||
|
|
@ -307,30 +460,47 @@ release:
|
|||
|
||||
### Which release archive/container should I use?
|
||||
|
||||
GoToSocial releases binary builds for 64-bit Linux, FreeBSD, and NetBSD operating systems. We also release Docker builds for 64-bit Linux.
|
||||
Tl;dr: Regardless of whether you're using SQLite or Postgres as your DB driver, you most likely you want the regular version without `moderncsqlite` in the name.
|
||||
|
||||
| OS | Architecture | Support level | Binary archive | Docker |
|
||||
| ------- | ----------------------- | ---------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------- |
|
||||
| Linux | x86-64/AMD64 (64-bit) | 🟢 Full | [linux_amd64.tar.gz](https://codeberg.org/superseriousbusiness/gotosocial/releases/download/{{ .Tag }}/gotosocial_{{ .Version }}_linux_amd64.tar.gz) | `docker.io/superseriousbusiness/gotosocial:{{ .Version }}` |
|
||||
| Linux | Armv8/ARM64 (64-bit) | 🟢 Full | [linux_arm64.tar.gz](https://codeberg.org/superseriousbusiness/gotosocial/releases/download/{{ .Tag }}/gotosocial_{{ .Version }}_linux_arm64.tar.gz) | `docker.io/superseriousbusiness/gotosocial:{{ .Version }}` |
|
||||
| FreeBSD | x86-64/AMD64 (64-bit) | 🟢 Full | [freebsd_amd64.tar.gz](https://codeberg.org/superseriousbusiness/gotosocial/releases/download/{{ .Tag }}/gotosocial_{{ .Version }}_freebsd_amd64.tar.gz) | Not provided |
|
||||
| FreeBSD | Armv8/ARM64 (64-bit) | 🟢 Full | [freebsd_arm64.tar.gz](https://codeberg.org/superseriousbusiness/gotosocial/releases/download/{{ .Tag }}/gotosocial_{{ .Version }}_freebsd_arm64.tar.gz) | Not provided |
|
||||
| NetBSD | x86-64/AMD64 (64-bit) | 🟢 Full | [netbsd_amd64.tar.gz](https://codeberg.org/superseriousbusiness/gotosocial/releases/download/{{ .Tag }}/gotosocial_{{ .Version }}_netbsd_amd64.tar.gz) | Not provided |
|
||||
| NetBSD | Armv8/ARM64 (64-bit) | 🟢 Full | [netbsd_arm64.tar.gz](https://codeberg.org/superseriousbusiness/gotosocial/releases/download/{{ .Tag }}/gotosocial_{{ .Version }}_netbsd_arm64.tar.gz) | Not provided |
|
||||
However, if you're on FreeBSD, 32-bit Linux or 32-bit ARM, we recommend using the `moderncsqlite` version instead.
|
||||
|
||||
#### `nowasm`
|
||||
You may need to change some configuration options too. See the table below:
|
||||
|
||||
For your convenience, we also provide **UNSUPPORTED, EXPERIMENTAL BUILDS**, created using the `nowasm` tag, in the downloads list below. There is no Docker build for `nowasm`.
|
||||
| OS | Architecture | Support level | Binary archive | Docker |
|
||||
| ------- | ----------------------- | ---------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------- |
|
||||
| Linux | x86-64/AMD64 (64-bit) | 🟢 Full | [linux_amd64.tar.gz](https://github.com/superseriousbusiness/gotosocial/releases/download/{{ .Tag }}/gotosocial_{{ .Version }}_linux_amd64.tar.gz) | `superseriousbusiness/gotosocial:{{ .Version }}` |
|
||||
| Linux | Armv8/ARM64 (64-bit) | 🟢 Full | [linux_arm64.tar.gz](https://github.com/superseriousbusiness/gotosocial/releases/download/{{ .Tag }}/gotosocial_{{ .Version }}_linux_arm64.tar.gz) | `superseriousbusiness/gotosocial:{{ .Version }}` |
|
||||
| FreeBSD | x86-64/AMD64 (64-bit) | 🟢 Full<sup>[1](#freebsd)</sup> | [freebsd_amd64_moderncsqlite.tar.gz](https://github.com/superseriousbusiness/gotosocial/releases/download/{{ .Tag }}/gotosocial_{{ .Version }}_freebsd_amd64_moderncsqlite.tar.gz) | None provided |
|
||||
| Linux | x86-32/i386 (32-bit) | 🟡 Partial<sup>[2](#32-bit)</sup> | [linux_386_moderncsqlite.tar.gz](https://github.com/superseriousbusiness/gotosocial/releases/download/{{ .Tag }}/gotosocial_{{ .Version }}_linux_386_moderncsqlite.tar.gz) | `superseriousbusiness/gotosocial:{{ .Version }}-moderncsqlite` |
|
||||
| Linux | Armv7/ARM32 (32-bit) | 🟡 Partial<sup>[2](#32-bit)</sup> | [linux_armv7_moderncsqlite.tar.gz](https://github.com/superseriousbusiness/gotosocial/releases/download/{{ .Tag }}/gotosocial_{{ .Version }}_linux_armv7_moderncsqlite.tar.gz) | `superseriousbusiness/gotosocial:{{ .Version }}-moderncsqlite` |
|
||||
| Linux | Armv6/ARM32 (32-bit) | 🟡 Partial<sup>[2](#32-bit)</sup> | [linux_armv6_moderncsqlite.tar.gz](https://github.com/superseriousbusiness/gotosocial/releases/download/{{ .Tag }}/gotosocial_{{ .Version }}_linux_armv7_moderncsqlite.tar.gz) | `superseriousbusiness/gotosocial:{{ .Version }}-moderncsqlite` |
|
||||
|
||||
GoToSocial releases built with `nowasm` use the Go-native, modernc version of SQLite instead of the WASM one, and will use *on-system ffmpeg and ffprobe binaries* for media processing.
|
||||
#### FreeBSD
|
||||
|
||||
Using a `nowasm` build is currently the only way to run GoToSocial on a 32-bit system.
|
||||
`moderncsqlite` version currently recommended, though you might have success with the regular WASM SQLite version.
|
||||
|
||||
For more information on running a `nowasm` build, see the [nowasm](https://docs.gotosocial.org/en/latest/advanced/builds/nowasm/) documentation page.
|
||||
If running with regular WASM SQLite and having instability or memory issues, the following settings *may* help:
|
||||
|
||||
```yaml
|
||||
db-max-open-conns-multiplier: 0
|
||||
db-sqlite-journal-mode: "TRUNCATE"
|
||||
db-sqlite-synchronous: "FULL"
|
||||
```
|
||||
|
||||
#### 32-bit
|
||||
|
||||
`moderncsqlite` version is needed, as performance with regular WASM SQLite is not guaranteed when running on 32-bit.
|
||||
|
||||
Remote media processing will likely not work with reasonable performance, so you should set the following config variables to prevent download of remote media onto your instance:
|
||||
|
||||
```yaml
|
||||
media-remote-max-size: 0
|
||||
media-emoji-remote-max-size: 0
|
||||
```
|
||||
|
||||
# https://goreleaser.com/customization/changelog/
|
||||
changelog:
|
||||
use: gitea
|
||||
use: github
|
||||
groups:
|
||||
- title: Features and performance
|
||||
regexp: '^.*\[(?:feature|performance).*\].*$'
|
||||
|
|
|
|||
|
|
@ -1,137 +0,0 @@
|
|||
# https://woodpecker-ci.org/docs/usage/workflow-syntax#when---global-workflow-conditions
|
||||
when:
|
||||
- event: pull_request
|
||||
|
||||
steps:
|
||||
# Lint the Go code only if
|
||||
# some Go files have changed.
|
||||
#
|
||||
# CI_PIPELINE_FILES is undefined if
|
||||
# files changed > 500, and empty on
|
||||
# force pushes, so account for this
|
||||
# and run step to be safe.
|
||||
lint:
|
||||
when:
|
||||
# https://woodpecker-ci.org/docs/usage/workflow-syntax#evaluate
|
||||
# https://woodpecker-ci.org/docs/usage/environment#built-in-environment-variables
|
||||
- evaluate: >-
|
||||
(not ("CI_PIPELINE_FILES" in $env)) ||
|
||||
CI_PIPELINE_FILES == "[]" ||
|
||||
any(fromJSON(CI_PIPELINE_FILES), { # startsWith "internal/" || # startsWith "cmd/" || # startsWith "testrig/" }) ||
|
||||
len(fromJSON(CI_PIPELINE_FILES)) == 0
|
||||
|
||||
# We use golangci-lint for linting.
|
||||
# See: https://golangci-lint.run/
|
||||
image: golangci/golangci-lint:v2.3.1
|
||||
pull: true
|
||||
|
||||
# https://woodpecker-ci.org/docs/administration/configuration/backends/docker#run-user
|
||||
backend_options:
|
||||
docker:
|
||||
user: 1000:1000
|
||||
|
||||
# https://woodpecker-ci.org/docs/usage/volumes
|
||||
volumes:
|
||||
- /woodpecker/gotosocial/go-build-cache:/.cache/go-build
|
||||
- /woodpecker/gotosocial/go-pkg-cache:/go/pkg
|
||||
- /woodpecker/gotosocial/golangci-lint-cache:/.cache/golangci-lint
|
||||
|
||||
# https://woodpecker-ci.org/docs/usage/environment
|
||||
environment:
|
||||
GOFLAGS: "-buildvcs=false"
|
||||
|
||||
# https://woodpecker-ci.org/docs/usage/workflow-syntax#commands
|
||||
commands:
|
||||
- golangci-lint run
|
||||
|
||||
# Test the Go code only if
|
||||
# some Go files have changed.
|
||||
#
|
||||
# CI_PIPELINE_FILES is undefined if
|
||||
# files changed > 500, and empty on
|
||||
# force pushes, so account for this
|
||||
# and run step to be safe.
|
||||
test:
|
||||
when:
|
||||
# https://woodpecker-ci.org/docs/usage/workflow-syntax#evaluate
|
||||
# https://woodpecker-ci.org/docs/usage/environment#built-in-environment-variables
|
||||
- evaluate: >-
|
||||
(not ("CI_PIPELINE_FILES" in $env)) ||
|
||||
CI_PIPELINE_FILES == "[]" ||
|
||||
any(fromJSON(CI_PIPELINE_FILES), { # startsWith "internal/" || # startsWith "cmd/" || # startsWith "testrig/" || # startsWith "vendor/" }) ||
|
||||
len(fromJSON(CI_PIPELINE_FILES)) == 0
|
||||
|
||||
image: golang:1.24-alpine
|
||||
pull: true
|
||||
|
||||
# https://woodpecker-ci.org/docs/administration/configuration/backends/docker#run-user
|
||||
backend_options:
|
||||
docker:
|
||||
user: 1000:1000
|
||||
|
||||
# https://woodpecker-ci.org/docs/usage/volumes
|
||||
volumes:
|
||||
- /woodpecker/gotosocial/go-build-cache:/.cache/go-build
|
||||
- /woodpecker/gotosocial/go-pkg-cache:/go/pkg
|
||||
- /woodpecker/gotosocial/wazero-compilation-cache:/.cache/wazero
|
||||
- /woodpecker/gotosocial/test-tmp:/tmp
|
||||
|
||||
# https://woodpecker-ci.org/docs/usage/environment
|
||||
environment:
|
||||
CGO_ENABLED: "0"
|
||||
GTS_WAZERO_COMPILATION_CACHE: "/.cache/wazero"
|
||||
|
||||
# https://woodpecker-ci.org/docs/usage/workflow-syntax#commands
|
||||
commands:
|
||||
- >-
|
||||
go test
|
||||
-ldflags="-s -w -extldflags '-static'"
|
||||
-tags="netgo osusergo static_build kvformat timetzdata"
|
||||
-failfast
|
||||
-timeout=30m
|
||||
./...
|
||||
- ./test/envparsing.sh
|
||||
- ./test/swagger.sh
|
||||
|
||||
# Validate the web code only
|
||||
# if web source has changed.
|
||||
#
|
||||
# CI_PIPELINE_FILES is undefined if
|
||||
# files changed > 500, and empty on
|
||||
# force pushes, so account for this
|
||||
# and run step to be safe.
|
||||
web:
|
||||
when:
|
||||
# https://woodpecker-ci.org/docs/usage/workflow-syntax#evaluate
|
||||
# https://woodpecker-ci.org/docs/usage/environment#built-in-environment-variables
|
||||
- evaluate: >-
|
||||
(not ("CI_PIPELINE_FILES" in $env)) ||
|
||||
CI_PIPELINE_FILES == "[]" ||
|
||||
any(fromJSON(CI_PIPELINE_FILES), { # startsWith "web/source/" }) ||
|
||||
len(fromJSON(CI_PIPELINE_FILES)) == 0
|
||||
|
||||
image: node:lts-alpine
|
||||
pull: true
|
||||
|
||||
# https://woodpecker-ci.org/docs/administration/configuration/backends/docker#run-user
|
||||
backend_options:
|
||||
docker:
|
||||
user: 1000:1000
|
||||
|
||||
# https://woodpecker-ci.org/docs/usage/volumes
|
||||
volumes:
|
||||
- /woodpecker/gotosocial/node_modules:/woodpecker/src/codeberg.org/superseriousbusiness/gotosocial/web/source/node_modules
|
||||
- /woodpecker/gotosocial/yarn-cache:/.cache/yarn
|
||||
- /woodpecker/gotosocial/web-dist-test:/woodpecker/src/codeberg.org/superseriousbusiness/gotosocial/web/assets/dist
|
||||
|
||||
# https://woodpecker-ci.org/docs/usage/workflow-syntax#commands
|
||||
commands:
|
||||
# Install web dependencies.
|
||||
- yarn --cwd ./web/source install --frozen-lockfile --cache-folder /.cache/yarn
|
||||
- yarn --cwd ./web/source ts-patch install # https://typia.io/docs/setup/#manual-setup
|
||||
|
||||
# Lint web source.
|
||||
- yarn --cwd ./web/source lint
|
||||
|
||||
# Ensure build works.
|
||||
- yarn --cwd ./web/source build
|
||||
|
|
@ -1,54 +0,0 @@
|
|||
# https://woodpecker-ci.org/docs/usage/workflow-syntax#when---global-workflow-conditions
|
||||
when:
|
||||
- event: tag
|
||||
|
||||
# https://goreleaser.com/ci/woodpecker/
|
||||
# https://woodpecker-ci.org/docs/usage/workflow-syntax#clone
|
||||
clone:
|
||||
git:
|
||||
image: woodpeckerci/plugin-git
|
||||
settings:
|
||||
tags: true
|
||||
|
||||
steps:
|
||||
release:
|
||||
# https://codeberg.org/superseriousbusiness/gotosocial-woodpecker-build
|
||||
image: superseriousbusiness/gotosocial-woodpecker-build:0.12.1
|
||||
pull: true
|
||||
|
||||
# https://woodpecker-ci.org/docs/usage/volumes
|
||||
volumes:
|
||||
- /woodpecker/gotosocial/go-build-cache-root:/root/.cache/go-build
|
||||
- /woodpecker/gotosocial/go-pkg-cache-root:/go/pkg
|
||||
- /var/run/docker.sock:/var/run/docker.sock
|
||||
|
||||
# https://woodpecker-ci.org/docs/usage/environment
|
||||
# https://woodpecker-ci.org/docs/usage/secrets#usage
|
||||
environment:
|
||||
# Needed for goreleaser to
|
||||
# push manifests + containers.
|
||||
DOCKER_USERNAME: gotosocial
|
||||
DOCKER_PASSWORD:
|
||||
from_secret: gts_docker_password
|
||||
|
||||
# Needed for goreleaser
|
||||
# to publish the release.
|
||||
# https://goreleaser.com/scm/gitea/
|
||||
GITEA_TOKEN:
|
||||
from_secret: codeberg_token
|
||||
|
||||
# https://woodpecker-ci.org/docs/usage/workflow-syntax#commands
|
||||
commands:
|
||||
- git fetch --tags
|
||||
- /go/dockerlogin.sh
|
||||
|
||||
# When releasing, compare commits to the most recent tag that is not the
|
||||
# current one AND is not a release candidate tag (ie., no "rc" in the name).
|
||||
#
|
||||
# The CI_COMMIT_TAG env var should point to the tag that triggered this build.
|
||||
# See: https://woodpecker-ci.org/docs/usage/environment
|
||||
#
|
||||
# Note, this may cause annoyances when doing backport releases, for example,
|
||||
# releasing v0.10.1 when we've already released v0.15.0 or whatever, but
|
||||
# they should only be superficial annoyances related to the release notes.
|
||||
- GORELEASER_PREVIOUS_TAG=$(git tag -l | grep -v "rc\|${CI_COMMIT_TAG}" | sort -V -r | head -n 1) goreleaser release --clean
|
||||
|
|
@ -1,76 +0,0 @@
|
|||
# https://woodpecker-ci.org/docs/usage/workflow-syntax#when---global-workflow-conditions
|
||||
when:
|
||||
- event: push
|
||||
branch: main
|
||||
|
||||
# https://goreleaser.com/ci/woodpecker/
|
||||
# https://woodpecker-ci.org/docs/usage/workflow-syntax#clone
|
||||
clone:
|
||||
git:
|
||||
image: woodpeckerci/plugin-git
|
||||
settings:
|
||||
tags: true
|
||||
|
||||
steps:
|
||||
snapshot:
|
||||
# Snapshot only if some interesting
|
||||
# source code files have changed.
|
||||
#
|
||||
# CI_PIPELINE_FILES is undefined if
|
||||
# files changed > 500, so account for
|
||||
# this and snapshot anyway if so.
|
||||
when:
|
||||
# https://woodpecker-ci.org/docs/usage/workflow-syntax#evaluate
|
||||
# https://woodpecker-ci.org/docs/usage/environment#built-in-environment-variables
|
||||
- evaluate: >-
|
||||
(not ("CI_PIPELINE_FILES" in $env)) ||
|
||||
CI_PIPELINE_FILES == "[]" ||
|
||||
any(fromJSON(CI_PIPELINE_FILES), { # startsWith "internal/" || # startsWith "cmd/" || # startsWith "testrig/" || # startsWith "vendor/" || # startsWith "web/" || # == "Dockerfile" }) ||
|
||||
len(fromJSON(CI_PIPELINE_FILES)) == 0
|
||||
|
||||
# https://codeberg.org/superseriousbusiness/gotosocial-woodpecker-build
|
||||
image: superseriousbusiness/gotosocial-woodpecker-build:0.12.1
|
||||
pull: true
|
||||
|
||||
# https://woodpecker-ci.org/docs/usage/volumes
|
||||
volumes:
|
||||
- /woodpecker/gotosocial/go-build-cache-root:/root/.cache/go-build
|
||||
- /woodpecker/gotosocial/go-pkg-cache-root:/go/pkg
|
||||
- /var/run/docker.sock:/var/run/docker.sock
|
||||
|
||||
# https://woodpecker-ci.org/docs/usage/environment
|
||||
# https://woodpecker-ci.org/docs/usage/secrets#usage
|
||||
environment:
|
||||
# Needed to push snapshot
|
||||
# manifests + containers.
|
||||
DOCKER_USERNAME: gotosocial
|
||||
DOCKER_PASSWORD:
|
||||
from_secret: gts_docker_password
|
||||
|
||||
# Needed for snapshot script
|
||||
# to publish artifacts to S3.
|
||||
S3_ACCESS_KEY_ID:
|
||||
from_secret: gts_s3_access_key_id
|
||||
S3_SECRET_ACCESS_KEY:
|
||||
from_secret: gts_s3_secret_access_key
|
||||
S3_HOSTNAME: "https://s3.superseriousbusiness.org"
|
||||
S3_BUCKET_NAME: "gotosocial-snapshots"
|
||||
|
||||
# https://woodpecker-ci.org/docs/usage/workflow-syntax#commands
|
||||
commands:
|
||||
# Create a snapshot build with GoReleaser.
|
||||
- git fetch --tags
|
||||
- goreleaser release --clean --snapshot
|
||||
|
||||
# Login to Docker, push Docker image snapshots + manifests.
|
||||
- /go/dockerlogin.sh
|
||||
- docker push superseriousbusiness/gotosocial:snapshot-arm64v8
|
||||
- docker push superseriousbusiness/gotosocial:snapshot-amd64
|
||||
- |
|
||||
docker manifest create superseriousbusiness/gotosocial:snapshot \
|
||||
superseriousbusiness/gotosocial:snapshot-amd64 \
|
||||
superseriousbusiness/gotosocial:snapshot-arm64v8
|
||||
- docker manifest push superseriousbusiness/gotosocial:snapshot
|
||||
|
||||
# Publish binary .tar.gz snapshots to S3.
|
||||
- /go/snapshot_publish.sh
|
||||
168
CONTRIBUTING.md
|
|
@ -18,23 +18,22 @@ These contribution guidelines were adapted from / inspired by those of Gitea (ht
|
|||
- [Docker](#docker)
|
||||
- [With GoReleaser](#with-goreleaser)
|
||||
- [Manually](#manually)
|
||||
- [Stylesheet / Web dev](#stylesheet-web-dev)
|
||||
- [Stylesheet / Web dev](#stylesheet--web-dev)
|
||||
- [Live Reloading](#live-reloading)
|
||||
- [Project Structure](#project-structure)
|
||||
- [Finding your way around the code](#finding-your-way-around-the-code)
|
||||
- [Style / Linting / Formatting](#style-linting-formatting)
|
||||
- [Style / Linting / Formatting](#style--linting--formatting)
|
||||
- [Testing](#testing)
|
||||
- [Standalone Testrig with Pinafore](#standalone-testrig-with-pinafore)
|
||||
- [Configuring the Standalone Testrig](#configuring-the-standalone-testrig)
|
||||
- [Standalone Testrig with Semaphore](#standalone-testrig-with-semaphore)
|
||||
- [Running automated tests](#running-automated-tests)
|
||||
- [SQLite](#sqlite)
|
||||
- [Postgres](#postgres)
|
||||
- [CLI Tests](#cli-tests)
|
||||
- [Federation](#federation)
|
||||
- [Updating Swagger docs](#updating-swagger-docs)
|
||||
- [CI/CD configuration](#ci-cd-configuration)
|
||||
- [Other Useful Stuff](#other-useful-stuff)
|
||||
- [Running migrations on a Postgres DB backup locally](#running-migrations-on-a-postgres-db-backup-locally)
|
||||
- [CI/CD configuration](#cicd-configuration)
|
||||
- [Release Checklist](#release-checklist)
|
||||
- [What if something goes wrong?](#what-if-something-goes-wrong)
|
||||
|
||||
## Introduction
|
||||
|
||||
|
|
@ -42,11 +41,11 @@ This document contains important information that will help you to write a succe
|
|||
|
||||
## Bug reports and feature requests
|
||||
|
||||
Currently, we use Codeberg's issue system for tracking bug reports and feature requests.
|
||||
Currently, we use Github's issue system for tracking bug reports and feature requests.
|
||||
|
||||
You can view all open issues [here](https://codeberg.org/superseriousbusiness/gotosocial/issues "The Codeberg Issues page for GoToSocial").
|
||||
You can view all open issues [here](https://github.com/superseriousbusiness/gotosocial/issues "The Github Issues page for GoToSocial").
|
||||
|
||||
Before opening a new issue, whether bug or feature request, **please search carefully through both open and closed issues to make sure it hasn't been addressed already**. You can use Codeberg's keyword issue search for this. If your issue is a duplicate of an existing issue, it will be closed.
|
||||
Before opening a new issue, whether bug or feature request, **please search carefully through both open and closed issues to make sure it hasn't been addressed already**. You can use Github's keyword issue search for this. If your issue is a duplicate of an existing issue, it will be closed.
|
||||
|
||||
Before you open a feature request issue, please consider the following:
|
||||
|
||||
|
|
@ -100,7 +99,7 @@ If you see something in the documentation that's missing, wrong, or unclear, fee
|
|||
|
||||
We support a [Conda](https://docs.conda.io/en/latest/)-based workflow for hacking, building & publishing the documentation. Here's how you can get started locally:
|
||||
|
||||
* Install [`miniconda`](https://www.anaconda.com/docs/getting-started/miniconda/main)
|
||||
* Install [`miniconda`](https://docs.conda.io/en/latest/miniconda.html)
|
||||
* Create your conda environment: `conda env create -f ./docs/environment.yml`
|
||||
* Activate the environment: `conda activate gotosocial-docs`
|
||||
* Serve locally: `mkdocs serve`
|
||||
|
|
@ -123,22 +122,26 @@ Beware that `conda env export` will add a `prefix` entry to the environment.yml
|
|||
|
||||
### Golang forking quirks
|
||||
|
||||
One of the quirks of Golang is that it relies on the source management path being the same as the one used within `go.mod` and in package imports within individual Go files. This makes working with forks a bit awkward. The solution to this is to fork, then clone the upstream repository, then set `origin` of the upstream repository to that of your fork.
|
||||
One of the quirks of Golang is that it relies on the source management path being the same as the one used within `go.mod` and in package imports within individual Go files. This makes working with forks a bit awkward.
|
||||
|
||||
Let's say you fork GoToSocial to `github.com/yourgithubname/gotosocial`, and then clone that repository to `~/go/src/github.com/yourgithubname/gotosocial`. You will probably run into errors trying to run tests or build, so you might change your `go.mod` file so that the module is called `github.com/yourgithubname/gotosocial` instead of `github.com/superseriousbusiness/gotosocial`. But then this breaks all the imports within the project. Nightmare! So now you have to go through the source files and painstakingly replace `github.com/superseriousbusiness/gotosocial` with `github.com/yourgithubname/gotosocial`. This works OK, but when you decide to make a pull request against the original repo, all the changed paths are included! Argh!
|
||||
|
||||
The correct solution to this is to fork, then clone the upstream repository, then set `origin` of the upstream repository to that of your fork.
|
||||
|
||||
See [this blog post](https://blog.sgmansfield.com/2016/06/working-with-forks-in-go/) for more details.
|
||||
|
||||
In case this post disappears, here are the steps (slightly modified):
|
||||
|
||||
>
|
||||
> Fork the repository on Codeberg or set up whatever other remote git repo you will be using. In this case, I would go to Codeberg and fork the repository.
|
||||
> Fork the repository on GitHub or set up whatever other remote git repo you will be using. In this case, I would go to GitHub and fork the repository.
|
||||
>
|
||||
> Now clone the upstream repo (not the fork):
|
||||
>
|
||||
> `mkdir -p ~/go/src/code.superseriousbusiness.org && git clone git@codeberg.org:superseriousbusiness/gotosocial ~/go/src/code.superseriousbusiness.org/gotosocial`
|
||||
> `mkdir -p ~/go/src/github.com/superseriousbusiness && git clone git@github.com:superseriousbusiness/gotosocial ~/go/src/github.com/superseriousbusiness/gotosocial`
|
||||
>
|
||||
> Navigate to the top level of the upstream repository on your computer:
|
||||
>
|
||||
> `cd ~/go/src/code.superseriousbusiness.org/gotosocial`
|
||||
> `cd ~/go/src/github.com/superseriousbusiness/gotosocial`
|
||||
>
|
||||
> Rename the current origin remote to upstream:
|
||||
>
|
||||
|
|
@ -146,7 +149,7 @@ In case this post disappears, here are the steps (slightly modified):
|
|||
>
|
||||
> Add your fork as origin:
|
||||
>
|
||||
> `git remote add origin git@codeberg.org:username/gotosocial`
|
||||
> `git remote add origin git@github.com/yourgithubname/gotosocial`
|
||||
>
|
||||
|
||||
Be sure to run `git fetch` before building the project for the first time.
|
||||
|
|
@ -155,9 +158,9 @@ Be sure to run `git fetch` before building the project for the first time.
|
|||
|
||||
#### Binary
|
||||
|
||||
To get started, you first need to have Go installed. Check the top of the `go.mod` file to see which version of Go you need to install, and see [here](https://golang.org/doc/install) for installation instructions.
|
||||
To get started, you first need to have Go installed. GtS is currently using Go 1.21, so you should take that too. See [here](https://golang.org/doc/install) for installation instructions.
|
||||
|
||||
Once you've got Go installed, clone this repository into your Go path. Normally, this should be `~/go/src/code.superseriousbusiness.org/gotosocial`.
|
||||
Once you've got go installed, clone this repository into your Go path. Normally, this should be `~/go/src/github.com/superseriousbusiness/gotosocial`.
|
||||
|
||||
Once you've installed the prerequisites, you can try building the project: `./scripts/build.sh`. This will build the `gotosocial` binary.
|
||||
|
||||
|
|
@ -173,7 +176,7 @@ nodemon -e go --signal SIGTERM --exec "go run ./cmd/gotosocial --host localhost
|
|||
|
||||
#### Docker
|
||||
|
||||
For both of the below methods, you need to have [Docker buildx](https://docs.docker.com/build/concepts/overview/#buildx) installed.
|
||||
For both of the below methods, you need to have [Docker buildx](https://docs.docker.com/buildx/working-with-buildx/) installed.
|
||||
|
||||
##### With GoReleaser
|
||||
|
||||
|
|
@ -185,7 +188,9 @@ Normally, these processes are handled by Drone (see CI/CD above). However, you c
|
|||
|
||||
To do this, first [install GoReleaser](https://goreleaser.com/install/).
|
||||
|
||||
Then install Node and Yarn as described in [Stylesheet / Web dev](#stylesheet-web-dev).
|
||||
Then install GoSwagger as described in [the Swagger section](#updating-swagger-docs).
|
||||
|
||||
Then install Node and Yarn as described in [Stylesheet / Web dev](#stylesheet--web-dev).
|
||||
|
||||
Finally, to create a snapshot build, do:
|
||||
|
||||
|
|
@ -197,7 +202,7 @@ If all goes according to plan, you should now have a number of multiple-architec
|
|||
|
||||
##### Manually
|
||||
|
||||
If you prefer a simple approach to building a Docker container, with fewer dependencies (Node, Yarn), you can also just build in the following way:
|
||||
If you prefer a simple approach to building a Docker container, with fewer dependencies (go-swagger, Node, Yarn), you can also just build in the following way:
|
||||
|
||||
```bash
|
||||
./scripts/build.sh && docker buildx build -t superseriousbusiness/gotosocial:latest .
|
||||
|
|
@ -205,8 +210,6 @@ If you prefer a simple approach to building a Docker container, with fewer depen
|
|||
|
||||
The above command first builds the `gotosocial` binary, then invokes Docker buildx to build the container image.
|
||||
|
||||
If you get an error while doing the build that looks like `"/web/assets/swagger.yaml": not found`, then you need to (re)generate the Swagger docs once, see [Updating Swagger docs](#updating-swagger-docs) for the command.
|
||||
|
||||
If you want to build a docker image for a different CPU architecture without setting up buildx (for example for ARMv7 aka 32-bit ARM), first modify the Dockerfile by adding the following lines to the top (but don't commit this!):
|
||||
|
||||
```dockerfile
|
||||
|
|
@ -394,13 +397,13 @@ If there's no output, great! It passed :)
|
|||
|
||||
### Testing
|
||||
|
||||
GoToSocial provides a [testrig](https://codeberg.org/superseriousbusiness/gotosocial/tree/main/testrig) with a number of mock packages you can use in integration tests.
|
||||
GoToSocial provides a [testrig](https://github.com/superseriousbusiness/gotosocial/tree/main/testrig) with a number of mock packages you can use in integration tests.
|
||||
|
||||
One thing that *isn't* mocked is the Database interface because it's just easier to use an in-memory SQLite database than to mock everything out.
|
||||
|
||||
#### Standalone Testrig with Pinafore
|
||||
#### Standalone Testrig with Semaphore
|
||||
|
||||
You can launch a testrig as a standalone server running at localhost, which you can connect to using something like [Pinafore](https://github.com/nolanlawson/pinafore/).
|
||||
You can launch a testrig as a standalone server running at localhost, which you can connect to using something like [Semaphore](https://github.com/NickColley/semaphore/).
|
||||
|
||||
To do this, first build the gotosocial binary with `DEBUG=1 ./scripts/build.sh`.
|
||||
|
||||
|
|
@ -410,14 +413,14 @@ Then, launch the testrig with the `DEBUG` environment variable set by invoking t
|
|||
DEBUG=1 ./gotosocial testrig start
|
||||
```
|
||||
|
||||
To run Pinafore locally in dev mode, first clone the [Pinafore](https://github.com/nolanlawson/pinafore/) repository, and then run the following commands in the cloned directory:
|
||||
To run Semaphore locally in dev mode, first clone the [Semaphore](https://github.com/NickColley/semaphore/) repository, and then run the following commands in the cloned directory:
|
||||
|
||||
```bash
|
||||
yarn # install dependencies
|
||||
yarn run dev
|
||||
```
|
||||
|
||||
The Pinafore instance will start running on `localhost:4002`.
|
||||
The Semaphore instance will start running on `localhost:4002`.
|
||||
|
||||
To connect to the testrig, navigate to `http://localhost:4002` and enter your instance name as `localhost:8080`.
|
||||
|
||||
|
|
@ -425,35 +428,10 @@ At the login screen, enter the email address `zork@example.org` and password `pa
|
|||
|
||||
Note the following constraints:
|
||||
|
||||
- Since the testrig uses an in-memory database by default, the database will be destroyed when the testrig is stopped.
|
||||
- If you stop the testrig and start it again, by default any tokens or applications you created during your tests will also be removed. As such, you need to log out and in again every time you stop/start the rig.
|
||||
- Since the testrig uses an in-memory database, the database will be destroyed when the testrig is stopped.
|
||||
- If you stop the testrig and start it again, any tokens or applications you created during your tests will also be removed. As such, you need to log out and in again every time you stop/start the rig.
|
||||
- The testrig does not make any actual external HTTP calls, so federation will not work from a testrig.
|
||||
|
||||
##### Configuring the Standalone Testrig
|
||||
|
||||
By default the standalone testrig uses an in-memory SQLite database, which is filled with test data when starting up, and is cleared when shutting down, but you can tweak this (and a few other settings) with environment variables:
|
||||
|
||||
- `GTS_LOG_LEVEL` - you can set this to `trace` if you want to see all DB queries.
|
||||
- `GTS_TESTRIG_SKIP_DB_SETUP` - set this to any value to skip the creation of tables and population of test data when the testrig starts.
|
||||
- `GTS_TESTRIG_SKIP_DB_TEARDOWN` - set this to any value to skip the deletion of tables and test data when the testrig stops.
|
||||
- `GTS_STORAGE_BACKEND` - this uses in-memory storage by default, but you can set this to `s3` to use a locally-running Minio etc for testing.
|
||||
- `GTS_DB_TYPE` - you can change this to `postgres` to test against a locally-running Postgres intance.
|
||||
- `GTS_DB_ADDRESS` - this is set to `:memory:` by default. You can change this to use an sqlite.db file somewhere, or set it to a Postgres address.
|
||||
- `GTS_DB_PORT`, `GTS_DB_USER`, `GTS_DB_PASSWORD`, `GTS_DB_DATABASE`, `GTS_DB_TLS_MODE`, `GTS_DB_TLS_CA_CERT` - you can set these if you change `GTS_DB_ADDRESS` to `postgres` and don't use `GTS_DB_POSTGRES_CONNECTION_STRING`.
|
||||
- `GTS_DB_POSTGRES_CONNECTION_STRING` - use this to provide a Postgres connection string if you don't want to set all the db env variables mentioned in the previous point.
|
||||
|
||||
Using these variables you can also (albeit awkwardly) test migrations from one schema to another.
|
||||
|
||||
For example, to test SQLite migrations:
|
||||
|
||||
1. Switch to main branch.
|
||||
2. Build the debug binary, and then start the testrig with `DEBUG=1 GTS_LOG_LEVEL=trace GTS_DB_ADDRESS=./sqlite.test.db GTS_TESTRIG_SKIP_DB_TEARDOWN=1 ./gotosocial testrig start`. This instructs the testrig to use trace logging, use an actual file for the SQLite db, and to skip tearing it down when finished.
|
||||
3. Stop the testrig.
|
||||
4. The file `sqlite.test.db` now contains the schema and test models from the main branch.
|
||||
5. Switch to the branch with the migration you want to test.
|
||||
6. Build the debug binary, and then start the testrig with `DEBUG=1 GTS_LOG_LEVEL=trace GTS_DB_ADDRESS=./sqlite.test.db GTS_TESTRIG_SKIP_DB_SETUP=1 ./gotosocial testrig start`. This instructs the testrig to use trace logging, and to use the already-populated sqlite.test.db file.
|
||||
7. You should see logging for migrations.
|
||||
|
||||
#### Running automated tests
|
||||
|
||||
Tests can be run against both SQLite and Postgres.
|
||||
|
|
@ -506,59 +484,65 @@ You'll additionally need functioning DNS for your two instance names, which you
|
|||
|
||||
GoToSocial uses [go-swagger](https://goswagger.io) to generate Swagger API documentation from code annotations.
|
||||
|
||||
If you change Swagger annotations on any of the API paths, you can generate a new Swagger file at `./docs/api/swagger.yaml`, and copy that file to web assets, by running:
|
||||
You can install go-swagger following the instructions [here](https://goswagger.io/install.html).
|
||||
|
||||
If you change Swagger annotations on any of the API paths, you can generate a new Swagger file at `./docs/api/swagger.yaml` by running:
|
||||
|
||||
```bash
|
||||
go run ./vendor/github.com/go-swagger/go-swagger/cmd/swagger \
|
||||
generate spec --scan-models --exclude-deps -o docs/api/swagger.yaml \
|
||||
&& cp docs/api/swagger.yaml web/assets/swagger.yaml
|
||||
swagger generate spec --scan-models --exclude-deps -o docs/api/swagger.yaml
|
||||
```
|
||||
|
||||
You shouldn't need to install go-swagger to run this command, as it's already included in the `vendor` folder.
|
||||
|
||||
### CI/CD configuration
|
||||
|
||||
GoToSocial uses [Woodpecker CI](https://woodpecker-ci.org/) for CI/CD tasks like running tests, linting, and building Docker containers.
|
||||
GoToSocial uses [Drone](https://www.drone.io/) for CI/CD tasks like running tests, linting, and building Docker containers.
|
||||
|
||||
These runs are integrated with Codeberg, and will be run on opening a pull request or merging into main.
|
||||
These runs are integrated with GitHub, and will be run on opening a pull request or merging into main.
|
||||
|
||||
The `woodpecker` pipeline files are in the `.woodpecker` directory of this repository — these define how and when Woodpecker should run.
|
||||
The Drone instance for GoToSocial is [here](https://drone.superseriousbusiness.org/superseriousbusiness/gotosocial).
|
||||
|
||||
The Woodpecker instance for GoToSocial is [here](https://woodpecker.superseriousbusiness.org/repos/2).
|
||||
The `drone.yml` file is [here](./.drone.yml) — this defines how and when Drone should run. Documentation for Drone is [here](https://docs.drone.io/).
|
||||
|
||||
Documentation for Woodpecker is [here](https://woodpecker-ci.org/docs/intro).
|
||||
It is worth noting that the `drone.yml` file must be signed by the Drone admin account to be considered valid. This must be done every time the file is changed. This is to prevent tampering and hijacking of the Drone instance. See [here](https://docs.drone.io/signature/).
|
||||
|
||||
## Other Useful Stuff
|
||||
|
||||
Various bits and bobs.
|
||||
|
||||
### Running migrations on a Postgres DB backup locally
|
||||
|
||||
It may be useful when testing or debugging migrations to be able to run them against a copy of a real instance's Postgres database locally.
|
||||
|
||||
Basic steps for this:
|
||||
|
||||
First dump the Postgres database on the remote machine, and copy the dump over to your development machine.
|
||||
|
||||
Now create a local Postgres container and mount the dump into it with, for example:
|
||||
To sign the file, first install and setup the [drone cli tool](https://docs.drone.io/cli/install/). Then, run:
|
||||
|
||||
```bash
|
||||
docker run -it --name postgres --network host -e POSTGRES_PASSWORD=postgres -v /path/to/db_dump:/db_dump postgres
|
||||
drone -t PUT_YOUR_DRONE_ADMIN_TOKEN_HERE -s https://drone.superseriousbusiness.org sign superseriousbusiness/gotosocial --save
|
||||
```
|
||||
|
||||
In a separate terminal window, execute a command inside the running container to load the dump into the "postgres" database:
|
||||
### Release Checklist
|
||||
|
||||
```bash
|
||||
docker exec -it --user postgres postgres psql -X -f /db_dump postgres
|
||||
```
|
||||
First things first: If this is a security hot-fix, we'll probably rush through this list, and make a prettier release a few days later.
|
||||
|
||||
With the Postgres container still running, run GoToSocial and point it towards the container. Use the appropriate `GTS_HOST` (and `GTS_ACCOUNT_DOMAIN`) values for the instance you dumped:
|
||||
Now, with that out of the way, here's our Checklist.
|
||||
|
||||
```bash
|
||||
GTS_HOST=example.org \
|
||||
GTS_DB_TYPE=postgres \
|
||||
GTS_DB_POSTGRES_CONNECTION_STRING=postgres://postgres:postgres@localhost:5432/postgres \
|
||||
./gotosocial migrations run
|
||||
```
|
||||
GoToSocial follows [Semantic Versioning](https://semver.org/).
|
||||
So our first concern on the Checklist is:
|
||||
|
||||
When you're done messing around, don't forget to remove any containers that you started up, and remove any lingering volumes with `docker volume prune`, else you might end up filling your disk with unused temporary volumes.
|
||||
- What version are we releasing?
|
||||
|
||||
Next we need to check:
|
||||
|
||||
- Do the assets have to be rebuilt and committed to the repository.
|
||||
- Do the swagger docs have to be rebuilt?
|
||||
|
||||
On the project management side:
|
||||
|
||||
- Are there any issues that have to be moved to a different milestone?
|
||||
- Are there any things on the [Roadmap](./ROADMAP.md) that can be ticked off?
|
||||
|
||||
Once we're happy with our Checklist, we can create the tag, and push it.
|
||||
And the rest [is automation](./.drone.yml).
|
||||
|
||||
We can now head to GitHub, and add some personality to the release notes.
|
||||
Finally, we make announcements on the all our channels that the release is out!
|
||||
|
||||
#### What if something goes wrong?
|
||||
|
||||
Sometimes things go awry.
|
||||
We release a buggy release, we forgot something something important.
|
||||
|
||||
If the release is so bad that it's unusable or dangerous! to a great part of our user-base, we can pull.
|
||||
That is: Delete the tag.
|
||||
|
||||
Either way, once we've resolved the issue, we just start from the top of this list again. Version numbers are cheap. It's cheap to burn them.
|
||||
|
|
|
|||
27
Dockerfile
|
|
@ -1,8 +1,25 @@
|
|||
# syntax=docker/dockerfile:1.3
|
||||
# Dockerfile reference: https://docs.docker.com/engine/reference/builder/
|
||||
|
||||
# stage 1: generate the web/assets/dist bundles
|
||||
FROM --platform=${BUILDPLATFORM} node:lts-alpine AS bundler
|
||||
# stage 1: generate up-to-date swagger.yaml to put in the final container
|
||||
FROM --platform=${BUILDPLATFORM} golang:1.22-alpine AS swagger
|
||||
|
||||
RUN \
|
||||
### Installs goswagger for building swagger definitions inside this container
|
||||
go install "github.com/go-swagger/go-swagger/cmd/swagger@c46c303aaa02" && \
|
||||
# Makes swagger executable
|
||||
chmod +x /go/bin/swagger
|
||||
|
||||
COPY go.mod /go/src/github.com/superseriousbusiness/gotosocial/go.mod
|
||||
COPY go.sum /go/src/github.com/superseriousbusiness/gotosocial/go.sum
|
||||
COPY cmd /go/src/github.com/superseriousbusiness/gotosocial/cmd
|
||||
COPY internal /go/src/github.com/superseriousbusiness/gotosocial/internal
|
||||
|
||||
WORKDIR /go/src/github.com/superseriousbusiness/gotosocial
|
||||
RUN /go/bin/swagger generate spec -o /go/src/github.com/superseriousbusiness/gotosocial/swagger.yaml --scan-models
|
||||
|
||||
# stage 2: generate the web/assets/dist bundles
|
||||
FROM --platform=${BUILDPLATFORM} node:18-alpine AS bundler
|
||||
|
||||
COPY web web
|
||||
RUN yarn --cwd ./web/source install && \
|
||||
|
|
@ -10,8 +27,8 @@ RUN yarn --cwd ./web/source install && \
|
|||
yarn --cwd ./web/source build && \
|
||||
rm -rf ./web/source
|
||||
|
||||
# stage 2: build the executor container
|
||||
FROM --platform=${TARGETPLATFORM} alpine:3.21 AS executor
|
||||
# stage 3: build the executor container
|
||||
FROM --platform=${TARGETPLATFORM} alpine:3.19.1 as executor
|
||||
|
||||
# switch to non-root user:group for GtS
|
||||
USER 1000:1000
|
||||
|
|
@ -33,7 +50,7 @@ COPY --chown=1000:1000 gotosocial /gotosocial/gotosocial
|
|||
|
||||
# copy over the web directories with templates, assets etc
|
||||
COPY --chown=1000:1000 --from=bundler web /gotosocial/web
|
||||
COPY --chown=1000:1000 ./web/assets/swagger.yaml /gotosocial/web/assets/swagger.yaml
|
||||
COPY --chown=1000:1000 --from=swagger /go/src/github.com/superseriousbusiness/gotosocial/swagger.yaml web/assets/swagger.yaml
|
||||
|
||||
VOLUME [ "/gotosocial/storage", "/gotosocial/.cache" ]
|
||||
ENTRYPOINT [ "/gotosocial/gotosocial", "server", "start" ]
|
||||
|
|
|
|||
178
README.md
|
|
@ -3,23 +3,23 @@
|
|||
|
||||
**Update regarding corporate sponsors: we are open to sponsorship arrangements with organizations that align with our values; see the conditions below**
|
||||
|
||||
🏳️🌈 GoToSocial is an [ActivityPub](https://activitypub.rocks/) social network server, written in Golang. 🏳️⚧️
|
||||
GoToSocial is an [ActivityPub](https://activitypub.rocks/) social network server, written in Golang.
|
||||
|
||||
With GoToSocial, you can keep in touch with your friends, post, read, and share images and articles. All without being tracked or advertised to!
|
||||
|
||||
<p align="middle">
|
||||
<img src="https://codeberg.org/superseriousbusiness/gotosocial/raw/branch/main/docs/overrides/public/sloth.webp" width="300"/>
|
||||
<img src="https://raw.githubusercontent.com/superseriousbusiness/gotosocial/main/docs/assets/sloth.webp" width="300"/>
|
||||
</p>
|
||||
|
||||
**GoToSocial is still [BETA SOFTWARE](https://en.wikipedia.org/wiki/Software_release_life_cycle#Beta)**. It is already deployable and useable, and it federates cleanly with many other Fediverse servers (not yet all). However, many things are not yet implemented, and there are plenty of bugs! We left alpha stage around September/October 2024, and we intend to exit beta some time around 2026.
|
||||
|
||||
Documentation is at [docs.gotosocial.org](https://docs.gotosocial.org). You can skip straight to the API documentation [here](https://docs.gotosocial.org/en/latest/api/swagger/).
|
||||
|
||||
To build from source, check the [CONTRIBUTING.md](https://codeberg.org/superseriousbusiness/gotosocial/src/branch/main/CONTRIBUTING.md) file.
|
||||
To build from source, check the [CONTRIBUTING.md](https://github.com/superseriousbusiness/gotosocial/blob/main/CONTRIBUTING.md) file.
|
||||
|
||||
Here's a screenshot of the instance landing page! Check out the project's [official account](https://gts.superseriousbusiness.org/@gotosocial) running on GoToSocial.
|
||||
Here's a screenshot of the instance landing page!
|
||||
|
||||

|
||||

|
||||
<!--overview-end-->
|
||||
|
||||
## Table of Contents <!-- omit in toc -->
|
||||
|
|
@ -36,22 +36,20 @@ Here's a screenshot of the instance landing page! Check out the project's [offic
|
|||
- [Rich text formatting](#rich-text-formatting)
|
||||
- [Themes and custom CSS](#themes-and-custom-css)
|
||||
- [Easy to run](#easy-to-run)
|
||||
- [Safety + security features](#safety-security-features)
|
||||
- [Safety + security features](#safety--security-features)
|
||||
- [Various federation modes](#various-federation-modes)
|
||||
- [OIDC integration](#oidc-integration)
|
||||
- [Backend-first design](#backend-first-design)
|
||||
- [Alternatives to GoToSocial](#alternatives-to-gotosocial)
|
||||
- [Known Issues](#known-issues)
|
||||
- [Installing GoToSocial](#installing-gotosocial)
|
||||
- [Supported Platforms](#supported-platforms)
|
||||
- [64-bit](#64-bit)
|
||||
- [BSDs](#bsds)
|
||||
- [FreeBSD](#freebsd)
|
||||
- [32-bit](#32-bit)
|
||||
- [OpenBSD](#openbsd)
|
||||
- [Stable Releases](#stable-releases)
|
||||
- [Snapshot Releases](#snapshot-releases)
|
||||
- [Docker](#docker)
|
||||
- [Binary release .tar.gz](#binary-release-tar-gz)
|
||||
- [Binary release .tar.gz](#binary-release-targz)
|
||||
- [From Source](#from-source)
|
||||
- [Third-party Packaging](#third-party-packaging)
|
||||
- [Contributing](#contributing)
|
||||
|
|
@ -61,7 +59,7 @@ Here's a screenshot of the instance landing page! Check out the project's [offic
|
|||
- [Image Attribution and Licensing](#image-attribution-and-licensing)
|
||||
- [Team](#team)
|
||||
- [Special Thanks](#special-thanks)
|
||||
- [Sponsorship + Funding](#sponsorship-funding)
|
||||
- [Sponsorship + Funding](#sponsorship--funding)
|
||||
- [Crowdfunding](#crowdfunding)
|
||||
- [Corporate Sponsorship](#corporate-sponsorship)
|
||||
- [NLnet](#nlnet)
|
||||
|
|
@ -74,7 +72,7 @@ GoToSocial provides a lightweight, customizable, and safety-focused entryway int
|
|||
|
||||
If you've ever used something like Twitter or Tumblr (or even Myspace!) GoToSocial will probably feel familiar to you: You can follow people and have followers, you make posts which people can favourite and reply to and share, and you scroll through posts from people you follow using a timeline. You can write long posts or short posts, or just post images, it's up to you. You can also, of course, block people or otherwise limit interactions that you don't want by posting just to your friends.
|
||||
|
||||

|
||||

|
||||
|
||||
**GoToSocial does NOT use recommendation algorithms or collect data about you to suggest content or 'improve your experience'**. The timeline is chronological: whatever you see at the top of your timeline is there because it's *just been posted*, not because it's been selected as interesting (or controversial) based on your personal profile.
|
||||
|
||||
|
|
@ -86,7 +84,7 @@ GoToSocial doesn't claim to be *better* than any other application, but it offer
|
|||
|
||||
Because GoToSocial uses [ActivityPub](https://activitypub.rocks/), you can hang out not just with people on your home server, but with people all over the [Fediverse](https://en.wikipedia.org/wiki/Fediverse), seamlessly.
|
||||
|
||||

|
||||

|
||||
|
||||
Federation means that your home server is part of a network of servers all over the world that all communicate using the same protocol. Your data is no longer centralized on one company's servers, but resides on your own server and is shared — as you see fit — across a resilient web of servers run by other people.
|
||||
|
||||
|
|
@ -102,7 +100,7 @@ It began as a solo project, and then picked up steam as more developers became i
|
|||
|
||||
We made our first Alpha release in November 2021. We left Alpha and entered Beta in September/October 2024.
|
||||
|
||||
For a detailed view on what's implemented and what's not, and progress made towards [stable release](https://en.wikipedia.org/wiki/Software_release_life_cycle#Stable_release), please see [the roadmap document](https://codeberg.org/superseriousbusiness/gotosocial/src/branch/main/ROADMAP.md).
|
||||
For a detailed view on what's implemented and what's not, and progress made towards [stable release](https://en.wikipedia.org/wiki/Software_release_life_cycle#Stable_release), please see [the roadmap document](https://github.com/superseriousbusiness/gotosocial/blob/main/ROADMAP.md).
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -115,7 +113,7 @@ The Mastodon API has become the de facto standard for client communication with
|
|||
Though most apps that implement the Mastodon API should work, GoToSocial is tested and works reliably with beautiful apps like:
|
||||
|
||||
* [Tusky](https://tusky.app/) for Android
|
||||
* [Pinafore](https://pinafore.social/) in the browser
|
||||
* [Semaphore](https://semaphore.social/) in the browser
|
||||
* [Feditext](https://github.com/feditext/feditext) (beta) on iOS, iPadOS and macOS
|
||||
|
||||
If you've used Mastodon with a third-party app before, you'll find using GoToSocial a breeze.
|
||||
|
|
@ -130,11 +128,11 @@ GoToSocial offers public, unlisted/unlocked, followers-only, and direct posts (s
|
|||
|
||||
GoToSocial lets you choose who can reply to your posts, via [interaction policies](https://docs.gotosocial.org/en/latest/user_guide/settings/#default-interaction-policies). You can choose to let anyone reply to your posts, let only your friends reply, and more.
|
||||
|
||||

|
||||

|
||||
|
||||
### Local-only posting
|
||||
|
||||
Sometimes you only want to talk to people you share an instance with. GoToSocial supports this via local-only posting, which ensures that your post stays on your instance only, even if it gets boosted. They also do not show up in the web interface, and are not accessible publicly via URL. (Local-only posting is currently dependent on client support.)
|
||||
Sometimes you only want to talk to people you share an instance with. GoToSocial supports this via local-only posting, which ensures that your post stays on your instance only. (Local-only posting is currently dependent on client support.)
|
||||
|
||||
### RSS feed
|
||||
|
||||
|
|
@ -144,7 +142,7 @@ GoToSocial lets you opt-in to exposing your profile as an RSS feed, so that peop
|
|||
|
||||
With GoToSocial, you can write posts using the popular, easy-to-use Markdown markup language, which lets you produce rich HTML posts with support for blockquotes, syntax-highlighted code blocks, lists, inline links, and more.
|
||||
|
||||

|
||||

|
||||
|
||||
### Themes and custom CSS
|
||||
|
||||
|
|
@ -155,91 +153,71 @@ It's also easy for admins to [add their own custom themes](https://docs.gotosoci
|
|||
<details>
|
||||
<summary>Show theme examples</summary>
|
||||
<figure>
|
||||
<img src="https://codeberg.org/superseriousbusiness/gotosocial/raw/branch/main/docs/overrides/public/theme-blurple-dark.png"/>
|
||||
<img src="https://raw.githubusercontent.com/superseriousbusiness/gotosocial/main/docs/assets/theme-blurple-dark.png"/>
|
||||
<figcaption>Blurple dark</figcaption>
|
||||
</figure>
|
||||
<hr/>
|
||||
<figure>
|
||||
<img src="https://codeberg.org/superseriousbusiness/gotosocial/raw/branch/main/docs/overrides/public/theme-blurple-light.png"/>
|
||||
<img src="https://raw.githubusercontent.com/superseriousbusiness/gotosocial/main/docs/assets/theme-blurple-light.png"/>
|
||||
<figcaption>Blurple light</figcaption>
|
||||
</figure>
|
||||
<hr/>
|
||||
<figure>
|
||||
<img src="https://codeberg.org/superseriousbusiness/gotosocial/raw/branch/main/docs/overrides/public/theme-brutalist-light.png"/>
|
||||
<img src="https://raw.githubusercontent.com/superseriousbusiness/gotosocial/main/docs/assets/theme-brutalist-light.png"/>
|
||||
<figcaption>Brutalist light</figcaption>
|
||||
</figure>
|
||||
<hr/>
|
||||
<figure>
|
||||
<img src="https://codeberg.org/superseriousbusiness/gotosocial/raw/branch/main/docs/overrides/public/theme-brutalist-dark.png"/>
|
||||
<img src="https://raw.githubusercontent.com/superseriousbusiness/gotosocial/main/docs/assets/theme-brutalist-dark.png"/>
|
||||
<figcaption>Brutalist dark</figcaption>
|
||||
</figure>
|
||||
<hr/>
|
||||
<figure>
|
||||
<img src="https://codeberg.org/superseriousbusiness/gotosocial/raw/branch/main/docs/overrides/public/theme-ecks-pee.png"/>
|
||||
<img src="https://raw.githubusercontent.com/superseriousbusiness/gotosocial/main/docs/assets/theme-ecks-pee.png"/>
|
||||
<figcaption>Ecks pee</figcaption>
|
||||
</figure>
|
||||
<hr/>
|
||||
<figure>
|
||||
<img src="https://codeberg.org/superseriousbusiness/gotosocial/raw/branch/main/docs/overrides/public/theme-midnight-trip.png"/>
|
||||
<img src="https://raw.githubusercontent.com/superseriousbusiness/gotosocial/main/docs/assets/theme-midnight-trip.png"/>
|
||||
<figcaption>Midnight trip</figcaption>
|
||||
</figure>
|
||||
<figure>
|
||||
<img src="https://codeberg.org/superseriousbusiness/gotosocial/raw/branch/main/docs/overrides/public/theme-moonlight-hunt.png"/>
|
||||
<img src="https://raw.githubusercontent.com/superseriousbusiness/gotosocial/main/docs/assets/theme-moonlight-hunt.png"/>
|
||||
<figcaption>Moonlight hunt</figcaption>
|
||||
</figure>
|
||||
<hr/>
|
||||
<figure>
|
||||
<img src="https://codeberg.org/superseriousbusiness/gotosocial/raw/branch/main/docs/overrides/public/theme-rainforest.png"/>
|
||||
<img src="https://raw.githubusercontent.com/superseriousbusiness/gotosocial/main/docs/assets/theme-rainforest.png"/>
|
||||
<figcaption>Rainforest</figcaption>
|
||||
</figure>
|
||||
<hr/>
|
||||
<figure>
|
||||
<img src="https://codeberg.org/superseriousbusiness/gotosocial/raw/branch/main/docs/overrides/public/theme-soft.png"/>
|
||||
<img src="https://raw.githubusercontent.com/superseriousbusiness/gotosocial/main/docs/assets/theme-soft.png"/>
|
||||
<figcaption>Soft</figcaption>
|
||||
</figure>
|
||||
<hr/>
|
||||
<figure>
|
||||
<img src="https://codeberg.org/superseriousbusiness/gotosocial/raw/branch/main/docs/overrides/public/theme-solarized-dark.png"/>
|
||||
<img src="https://raw.githubusercontent.com/superseriousbusiness/gotosocial/main/docs/assets/theme-solarized-dark.png"/>
|
||||
<figcaption>Solarized dark</figcaption>
|
||||
</figure>
|
||||
<hr/>
|
||||
<figure>
|
||||
<img src="https://codeberg.org/superseriousbusiness/gotosocial/raw/branch/main/docs/overrides/public/theme-solarized-light.png"/>
|
||||
<img src="https://raw.githubusercontent.com/superseriousbusiness/gotosocial/main/docs/assets/theme-solarized-light.png"/>
|
||||
<figcaption>Solarized light</figcaption>
|
||||
</figure>
|
||||
<hr/>
|
||||
<figure>
|
||||
<img src="https://codeberg.org/superseriousbusiness/gotosocial/raw/branch/main/docs/overrides/public/theme-sunset.png"/>
|
||||
<img src="https://raw.githubusercontent.com/superseriousbusiness/gotosocial/main/docs/assets/theme-sunset.png"/>
|
||||
<figcaption>Sunset</figcaption>
|
||||
</figure>
|
||||
<hr/>
|
||||
<figure>
|
||||
<img src="https://codeberg.org/superseriousbusiness/gotosocial/raw/branch/main/docs/overrides/public/theme-hacker-dark.png"/>
|
||||
<figcaption>Hacker dark</figcaption>
|
||||
</figure>
|
||||
<hr/>
|
||||
<figure>
|
||||
<img src="https://codeberg.org/superseriousbusiness/gotosocial/raw/branch/main/docs/overrides/public/theme-hacker-light.png"/>
|
||||
<figcaption>Hacker light</figcaption>
|
||||
</figure>
|
||||
<hr/>
|
||||
<figure>
|
||||
<img src="https://codeberg.org/superseriousbusiness/gotosocial/raw/branch/main/docs/overrides/public/theme-programmer-socks-dark.png"/>
|
||||
<figcaption>Programmer socks dark</figcaption>
|
||||
</figure>
|
||||
<hr/>
|
||||
<figure>
|
||||
<img src="https://codeberg.org/superseriousbusiness/gotosocial/raw/branch/main/docs/overrides/public/theme-programmer-socks-light.png"/>
|
||||
<figcaption>Programmer socks light</figcaption>
|
||||
</figure>
|
||||
<hr/>
|
||||
</details>
|
||||
|
||||
### Easy to run
|
||||
|
||||
GoToSocial uses only about 250-350MiB of RAM, and requires very little CPU power, so it plays nice with single-board computers, old laptops and tiny $5/month VPSes.
|
||||
|
||||

|
||||

|
||||
|
||||
No external dependencies apart from a database (or just use SQLite!).
|
||||
|
||||
|
|
@ -247,12 +225,10 @@ Simply download the binary + assets (or Docker container), tweak your configurat
|
|||
|
||||
### Safety + security features
|
||||
|
||||
- Strict privacy enforcement for posts, and strict blocking logic.
|
||||
- [Choose the visibility of posts on the web view of your profile](https://docs.gotosocial.org/en/latest/user_guide/settings/#visibility-level-of-posts-to-show-on-your-profile).
|
||||
- [Import, export](https://docs.gotosocial.org/en/latest/admin/settings/#importexport), and [subscribe](https://docs.gotosocial.org/en/latest/admin/domain_permission_subscriptions) to community-created domain allow and domain block lists.
|
||||
- HTTP signature authentication: GoToSocial requires [HTTP Signatures](https://datatracker.ietf.org/doc/html/draft-cavage-http-signatures-12) when sending and receiving messages, to ensure that your messages can't be tampered with and your identity can't be forged.
|
||||
- Built-in, automatic support for secure HTTPS with [Let's Encrypt](https://letsencrypt.org/).
|
||||
- Support for two-factor authentication via time-based one-time passwords (Google authenticator, LastPass authenticator, etc).
|
||||
- Strict privacy enforcement for posts and strict blocking logic.
|
||||
- Import and export allow lists and deny lists. Subscribe to community-created block lists (think Ad blocker, but for federation!) (feature still in progress).
|
||||
- HTTP signature authentication: GoToSocial requires [HTTP Signatures](https://datatracker.ietf.org/doc/html/draft-cavage-http-signatures-12) when sending and receiving messages, to ensure that your messages can't be tampered with and your identity can't be forged.
|
||||
|
||||
### Various federation modes
|
||||
|
||||
|
|
@ -278,29 +254,17 @@ On top of this API, web developers are encouraged to build any front-end impleme
|
|||
|
||||
---
|
||||
|
||||
## Alternatives to GoToSocial
|
||||
|
||||
Don't like GtS but still want to use the fediverse? Like GtS but prefer not to use beta software? There are lots of alternatives that might suit you better! Here are some that we know work well (alphabetical order):
|
||||
|
||||
- [Akkoma](https://akkoma.social/): Full-featured ActivityPub microblogging with emoji reacts and quote posts (Elixir).
|
||||
- [Honk](https://humungus.tedunangst.com/r/honk/m/activitypub.7): Minimalist, opinionated microblogging with "No likes, no faves, no polls, no stars, no claps, no counts." (Go).
|
||||
- [Iceshrimp.net](https://iceshrimp.dev/iceshrimp/Iceshrimp.NET): rewrite of Iceshrimp from the ground up (.Net).
|
||||
- [Mastodon](https://joinmastodon.org/): Actively developed, widely recognized, scaleable ActivityPub microblogging instance (Ruby).
|
||||
- [Snac2](https://codeberg.org/grunfink/snac2): Simple, minimalistic instance with very low system requirements (portable C).
|
||||
|
||||
---
|
||||
|
||||
## Known Issues
|
||||
|
||||
Since GoToSocial is still in beta, there are plenty of bugs. We use [Codeberg issues](https://codeberg.org/superseriousbusiness/gotosocial/issues?labels=378161) to track these.
|
||||
Since GoToSocial is still in beta, there are plenty of bugs. We use [GitHub issues](https://github.com/superseriousbusiness/gotosocial/issues?q=is%3Aissue+is%3Aopen+label%3Abug) to track these.
|
||||
|
||||
Since every ActivityPub server implementation has a slightly different interpretation of the protocol, some servers don't quite federate properly with GoToSocial yet. We're tracking these issues [with the federation label](https://codeberg.org/superseriousbusiness/gotosocial/issues?labels=378188). Eventually, we want to make sure that any implementation that can federate nicely with Mastodon should also be able to federate with GoToSocial.
|
||||
Since every ActivityPub server implementation has a slightly different interpretation of the protocol, some servers don't quite federate properly with GoToSocial yet. We're tracking these issues [in this project](https://github.com/superseriousbusiness/gotosocial/projects/4). Eventually, we want to make sure that any implementation that can federate nicely with Mastodon should also be able to federate with GoToSocial.
|
||||
|
||||
---
|
||||
|
||||
## Installing GoToSocial
|
||||
|
||||
Check our [getting started](https://docs.gotosocial.org/en/latest/getting_started/) documentation! And have a peruse of our [releases page](https://codeberg.org/superseriousbusiness/gotosocial/releases).
|
||||
Check our [getting started](https://docs.gotosocial.org/en/latest/getting_started/) documentation! And have a peruse of our [releases page](https://github.com/superseriousbusiness/gotosocial/releases).
|
||||
|
||||
<!--releases-start-->
|
||||
### Supported Platforms
|
||||
|
|
@ -311,32 +275,19 @@ Platforms that we don't officially support *may* still work, but we can't test o
|
|||
|
||||
This is the current status of support offered by GoToSocial for different platforms (if something is unlisted it means we haven't checked yet so we don't know):
|
||||
|
||||
| OS | Architecture | Support level | Binary archive | Docker container |
|
||||
| ------- | ----------------------- | ----------------------------------------- | -------------- | ---------------- |
|
||||
| Linux | x86-64/AMD64 (64-bit) | 🟢 Full<sup>[1](#64-bit)</sup> | Yes | Yes |
|
||||
| Linux | Armv8/ARM64 (64-bit) | 🟢 Full<sup>[1](#64-bit)</sup> | Yes | Yes |
|
||||
| FreeBSD | x86-64/AMD64 (64-bit) | 🟢 Full<sup>[1](#64-bit),[2](#bsds)</sup> | Yes | No |
|
||||
| FreeBSD | Armv8/ARM64 (64-bit) | 🟢 Full<sup>[1](#64-bit),[2](#bsds)</sup> | Yes | No |
|
||||
| NetBSD | x86-64/AMD64 (64-bit) | 🟢 Full<sup>[1](#64-bit),[2](#bsds)</sup> | Yes | No |
|
||||
| NetBSD | Armv8/ARM64 (64-bit) | 🟢 Full<sup>[1](#64-bit),[2](#bsds)</sup> | Yes | No |
|
||||
| Linux | x86-32/i386 (32-bit) | 🟡 Partial<sup>[3](#32-bit)</sup> | Yes | Yes |
|
||||
| Linux | Armv7/ARM32 (32-bit) | 🟡 Partial<sup>[3](#32-bit)</sup> | Yes | Yes |
|
||||
| Linux | Armv6/ARM32 (32-bit) | 🟡 Partial<sup>[3](#32-bit)</sup> | Yes | Yes |
|
||||
| OpenBSD | Any | 🔴 None<sup>[4](#openbsd)</sup> | No | No |
|
||||
| OS | Architecture | Support level | Binary archive | Docker container |
|
||||
| ------- | ----------------------- | ---------------------------------- | -------------- | ---------------- |
|
||||
| Linux | x86-64/AMD64 (64-bit) | 🟢 Full | Yes | Yes |
|
||||
| Linux | Armv8/ARM64 (64-bit) | 🟢 Full | Yes | Yes |
|
||||
| FreeBSD | x86-64/AMD64 (64-bit) | 🟢 Full<sup>[1](#freebsd)</sup> | Yes | No |
|
||||
| Linux | x86-32/i386 (32-bit) | 🟡 Partial<sup>[2](#32-bit)</sup> | Yes | Yes |
|
||||
| Linux | Armv7/ARM32 (32-bit) | 🟡 Partial<sup>[2](#32-bit)</sup> | Yes | Yes |
|
||||
| Linux | Armv6/ARM32 (32-bit) | 🟡 Partial<sup>[2](#32-bit)</sup> | Yes | Yes |
|
||||
| OpenBSD | Any | 🔴 None<sup>[3](#openbsd)</sup> | No | No |
|
||||
|
||||
#### 64-bit
|
||||
#### FreeBSD
|
||||
|
||||
Notes on 64-bit CPU feature requirements:
|
||||
|
||||
- x86_64 requires the [x86-64-v2](https://en.wikipedia.org/wiki/X86-64-v2) level instruction sets. (CPUs manufactured after ~2010)
|
||||
|
||||
- ARM64 requires no specific features, ARMv8 CPUs (and later) have all required features.
|
||||
|
||||
If any of the above features are missing, performance of media processing (and possibly, SQLite) will suffer. In these situations, you may have some success building a binary yourself with the totally **unsupported, experimental** [nowasm](https://docs.gotosocial.org/en/latest/advanced/builds/nowasm/) tag.
|
||||
|
||||
#### BSDs
|
||||
|
||||
Mostly works, just [a few things to keep in mind](https://github.com/ncruces/go-sqlite3/wiki/Support-matrix) with WASM SQLite; check release notes carefully when installing on NetBSD or FreeBSD. If running with Postgres you should have no issues.
|
||||
Mostly works, just a few issues with WASM SQLite; check release notes carefully when installing on FreeBSD. If running with Postgres you should have no issues.
|
||||
|
||||
#### 32-bit
|
||||
|
||||
|
|
@ -348,7 +299,7 @@ For more guidance, check release notes when trying to install on 32-bit.
|
|||
|
||||
#### OpenBSD
|
||||
|
||||
Marked as unsupported due to performance issues (no WASM compiler, high memory usage when idle, crashes while processing media).
|
||||
Marked as unsupported due to performance issues (high memory usage when idle, crashes while processing media).
|
||||
|
||||
While we don't support running GtS on OpenBSD, you may have some success building a binary yourself with the totally **unsupported, experimental** [nowasm](https://docs.gotosocial.org/en/latest/advanced/builds/nowasm/) tag.
|
||||
|
||||
|
|
@ -356,7 +307,7 @@ While we don't support running GtS on OpenBSD, you may have some success buildin
|
|||
|
||||
We package our stable releases for both binary builds and Docker containers, so that you don't have to build from source yourself.
|
||||
|
||||
The Docker image `docker.io/superseriousbusiness/gotosocial:latest` will always correspond to the latest stable release. Since this tag is overwritten frequently, you may want to use Docker CLI flag `--pull always` to ensure that you always have the most up-to-date image every time you run using this tag. Alternatively, run `docker pull docker.io/superseriousbusiness/gotosocial:latest` manually just before use.
|
||||
The Docker image `superseriousbusiness/gotosocial:latest` will always correspond to the latest stable release. Since this tag is overwritten frequently, you may want to use Docker CLI flag `--pull always` to ensure that you always have the most up-to-date image every time you run using this tag. Alternatively, run `docker pull superseriousbusiness/gotosocial:latest` manually just before use.
|
||||
|
||||
### Snapshot Releases
|
||||
|
||||
|
|
@ -366,17 +317,17 @@ Please be warned that you do so at your own risk! We try to keep main working pr
|
|||
|
||||
#### Docker
|
||||
|
||||
To run from main using Docker, use the `snapshot` Docker tag. The Docker image `docker.io/superseriousbusiness/gotosocial:snapshot` will always correspond to the latest commit on main that involves changes to Go code or web assets/source. Since this tag is overwritten frequently, you may want to use Docker CLI flag `--pull always` to ensure that you always have the most up-to-date image every time you run using this tag. Alternatively, run `docker pull docker.io/superseriousbusiness/gotosocial:snapshot` manually just before use.
|
||||
To run from main using Docker, use the `snapshot` Docker tag. The Docker image `superseriousbusiness/gotosocial:snapshot` will always correspond to the latest commit on main. Since this tag is overwritten frequently, you may want to use Docker CLI flag `--pull always` to ensure that you always have the most up-to-date image every time you run using this tag. Alternatively, run `docker pull superseriousbusiness/gotosocial:snapshot` manually just before use.
|
||||
|
||||
#### Binary release .tar.gz
|
||||
|
||||
To run from main using a binary release, download the appropriate .tar.gz file for your architecture from our [self-hosted Minio S3 repository](https://minio.s3.superseriousbusiness.org/browser/gotosocial-snapshots).
|
||||
|
||||
Snapshot binary releases in the S3 bucket are keyed by commit hash. To get the latest one, sort by Last Modified, or check out the list of commits [here](https://codeberg.org/superseriousbusiness/gotosocial/commits/main), copy the SHA of the latest one, and paste it in the Minio console filter. Snapshot binary releases are expired after 28 days, to keep our hosting costs down.
|
||||
Snapshot binary releases in the S3 bucket are keyed by Github commit hash. To get the latest one, sort by Last Modified, or check out the list of commits [here](https://github.com/superseriousbusiness/gotosocial/commits/main), copy the SHA of the latest one, and paste it in the Minio console filter. Snapshot binary releases are expired after 28 days, to keep our hosting costs down.
|
||||
|
||||
### From Source
|
||||
|
||||
Instructions for building GoToSocial from source are in the [CONTRIBUTING.md](https://codeberg.org/superseriousbusiness/gotosocial/src/branch/main/CONTRIBUTING.md) file.
|
||||
Instructions for building GoToSocial from source are in the [CONTRIBUTING.md](https://github.com/superseriousbusiness/gotosocial/blob/main/CONTRIBUTING.md) file.
|
||||
|
||||
### Third-party Packaging
|
||||
|
||||
|
|
@ -397,7 +348,7 @@ You can also deploy your own instance of GoToSocial with the help of:
|
|||
|
||||
## Contributing
|
||||
|
||||
You would like to contribute to GtS? Great! ❤️❤️❤️ Check out the issues page to see if there's anything you intend to jump in on, and read the [CONTRIBUTING.md](https://codeberg.org/superseriousbusiness/gotosocial/src/branch/main/CONTRIBUTING.md) file for guidelines and setting up your dev environment.
|
||||
You would like to contribute to GtS? Great! ❤️❤️❤️ Check out the issues page to see if there's anything you intend to jump in on, and read the [CONTRIBUTING.md](https://github.com/superseriousbusiness/gotosocial/blob/main/CONTRIBUTING.md) file for guidelines and setting up your dev environment.
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -405,7 +356,7 @@ You would like to contribute to GtS? Great! ❤️❤️❤️ Check out the iss
|
|||
|
||||
For questions and comments, you can [join our Matrix space](https://matrix.to/#/#gotosocial-space:superseriousbusiness.org) at `#gotosocial-space:superseriousbusiness.org`. This is the quickest way to reach the devs. You can also mail [admin@gotosocial.org](mailto:admin@gotosocial.org).
|
||||
|
||||
For bugs and feature requests, please check to see if there's [already an issue](https://codeberg.org/superseriousbusiness/gotosocial/issues), and if not, open one or use one of the above channels to make a request (if you don't have a Codeberg account).
|
||||
For bugs and feature requests, please check to see if there's [already an issue](https://github.com/superseriousbusiness/gotosocial/issues), and if not, open one or use one of the above channels to make a request (if you don't have a Github account).
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -444,7 +395,6 @@ The following open source libraries, frameworks, and tools are used by GoToSocia
|
|||
- [gruf/go-mutexes](https://codeberg.org/gruf/go-mutexes); safemutex & mutex map. [MIT License](https://spdx.org/licenses/MIT.html).
|
||||
- [gruf/go-runners](https://codeberg.org/gruf/go-runners); synchronization utilities. [MIT License](https://spdx.org/licenses/MIT.html).
|
||||
- [gruf/go-sched](https://codeberg.org/gruf/go-sched); task scheduler. [MIT License](https://spdx.org/licenses/MIT.html).
|
||||
- [gruf/go-split](https://codeberg.org/gruf/go-split); configuration string handling. [MIT License](https://spdx.org/licenses/MIT.html).
|
||||
- [gruf/go-storage](https://codeberg.org/gruf/go-storage); file storage backend (local & s3). [MIT License](https://spdx.org/licenses/MIT.html).
|
||||
- [gruf/go-structr](https://codeberg.org/gruf/go-structr); struct caching + queueing with automated indexing by field. [MIT License](https://spdx.org/licenses/MIT.html).
|
||||
- jackc:
|
||||
|
|
@ -461,17 +411,15 @@ The following open source libraries, frameworks, and tools are used by GoToSocia
|
|||
- [mvdan.cc/xurls](https://github.com/mvdan/xurls); URL parsing regular expressions. [BSD-3-Clause License](https://spdx.org/licenses/BSD-3-Clause.html).
|
||||
- [oklog/ulid](https://github.com/oklog/ulid); sequential, database-friendly ID generation. [Apache-2.0 License](https://spdx.org/licenses/Apache-2.0.html).
|
||||
- [open-telemetry/opentelemetry-go](https://github.com/open-telemetry/opentelemetry-go); OpenTelemetry API + SDK. [Apache-2.0 License](https://spdx.org/licenses/Apache-2.0.html).
|
||||
- [pquerna/otp](https://github.com/pquerna/otp); One Time Password utilities. [Apache-2.0 License](https://spdx.org/licenses/Apache-2.0.html).
|
||||
- spf13:
|
||||
- [spf13/cobra](https://github.com/spf13/cobra); command-line tooling. [Apache-2.0 License](https://spdx.org/licenses/Apache-2.0.html).
|
||||
- [spf13/viper](https://github.com/spf13/viper); configuration management. [Apache-2.0 License](https://spdx.org/licenses/Apache-2.0.html).
|
||||
- [stretchr/testify](https://github.com/stretchr/testify); test framework. [MIT License](https://spdx.org/licenses/MIT.html).
|
||||
- superseriousbusiness:
|
||||
- [superseriousbusiness/activity](https://code.superseriousbusiness.org/activity) forked from [go-fed/activity](https://github.com/go-fed/activity); Golang ActivityPub/ActivityStreams library. [BSD-3-Clause License](https://spdx.org/licenses/BSD-3-Clause.html).
|
||||
- [superseriousbusiness/exif-terminator](https://code.superseriousbusiness.org/exif-terminator); EXIF data removal. [GNU AGPL v3 LICENSE](https://spdx.org/licenses/AGPL-3.0-or-later.html).
|
||||
- [superseriousbusiness/httpsig](https://code.superseriousbusiness.org/httpsig) forked from [go-fed/httpsig](https://github.com/go-fed/httpsig); secure HTTP signature library. [BSD-3-Clause License](https://spdx.org/licenses/BSD-3-Clause.html).
|
||||
- [superseriousbusiness/oauth2](https://code.superseriousbusiness.org/oauth2) forked from [go-oauth2/oauth2](https://github.com/go-oauth2/oauth2); OAuth server framework and token handling. [MIT License](https://spdx.org/licenses/MIT.html).
|
||||
- [temoto/robotstxt](https://github.com/temoto/robotstxt); robots.txt parsing. [MIT License](https://spdx.org/licenses/MIT.html).
|
||||
- [superseriousbusiness/activity](https://github.com/superseriousbusiness/activity) forked from [go-fed/activity](https://github.com/go-fed/activity); Golang ActivityPub/ActivityStreams library. [BSD-3-Clause License](https://spdx.org/licenses/BSD-3-Clause.html).
|
||||
- [superseriousbusiness/exif-terminator](https://codeberg.org/superseriousbusiness/exif-terminator); EXIF data removal. [GNU AGPL v3 LICENSE](https://spdx.org/licenses/AGPL-3.0-or-later.html).
|
||||
- [superseriousbusiness/httpsig](https://github.com/superseriousbusiness/httpsig) forked from [go-fed/httpsig](https://github.com/go-fed/httpsig); secure HTTP signature library. [BSD-3-Clause License](https://spdx.org/licenses/BSD-3-Clause.html).
|
||||
- [superseriousbusiness/oauth2](https://github.com/superseriousbusiness/oauth2) forked from [go-oauth2/oauth2](https://github.com/go-oauth2/oauth2); OAuth server framework and token handling. [MIT License](https://spdx.org/licenses/MIT.html).
|
||||
- [tdewolff/minify](https://github.com/tdewolff/minify); HTML minification for Markdown-submitted posts. [MIT License](https://spdx.org/licenses/MIT.html).
|
||||
- [uber-go/automaxprocs](https://github.com/uber-go/automaxprocs); GOMAXPROCS automation. [MIT License](https://spdx.org/licenses/MIT.html).
|
||||
- [ulule/limiter](https://github.com/ulule/limiter); http rate limit middleware. [MIT License](https://spdx.org/licenses/MIT.html).
|
||||
|
|
@ -488,10 +436,10 @@ Sloth logo by [Anna Abramek](https://abramek.art/).
|
|||
|
||||
The Creative Commons Attribution-ShareAlike 4.0 International License license applies specifically to the following files and subdirectories of this repository:
|
||||
|
||||
- [sloth logo png](https://codeberg.org/superseriousbusiness/gotosocial/src/branch/main/web/assets/logo.png)
|
||||
- [sloth logo webp](https://codeberg.org/superseriousbusiness/gotosocial/src/branch/main/web/assets/logo.webp)
|
||||
- [sloth logo svg](https://codeberg.org/superseriousbusiness/gotosocial/src/branch/main/web/assets/logo.svg)
|
||||
- [all default avatars](https://codeberg.org/superseriousbusiness/gotosocial/src/branch/main/web/assets/default_avatars)
|
||||
- [sloth logo png](https://github.com/superseriousbusiness/gotosocial/blob/main/web/assets/logo.png)
|
||||
- [sloth logo webp](https://github.com/superseriousbusiness/gotosocial/blob/main/web/assets/logo.webp)
|
||||
- [sloth logo svg](https://github.com/superseriousbusiness/gotosocial/blob/main/web/assets/logo.svg)
|
||||
- [all default avatars](https://github.com/superseriousbusiness/gotosocial/blob/main/web/assets/default_avatars)
|
||||
|
||||
Under the terms of the license, you are free to:
|
||||
|
||||
|
|
@ -549,7 +497,7 @@ If after reading this you are still interested in supporting us, that is wonderf
|
|||
|
||||
<img src="https://nlnet.nl/logo/NGI/NGIZero-green.hex.svg" width="75" alt="NGIZero logo"/>
|
||||
|
||||
Combined with the above crowdfunding sources, 2023 Alpha development of GoToSocial was funded by a 50,000 EUR grant from the [NGI0 Entrust Fund](https://nlnet.nl/entrust/), via [NLnet](https://nlnet.nl/). See [here](https://nlnet.nl/project/GoToSocial/#ack) for more details. The successful grant application is archived [here](https://codeberg.org/superseriousbusiness/gotosocial/src/branch/main/archive/nlnet/2022-next-generation-internet-zero.md).
|
||||
Combined with the above crowdfunding sources, 2023 Alpha development of GoToSocial was funded by a 50,000 EUR grant from the [NGI0 Entrust Fund](https://nlnet.nl/entrust/), via [NLnet](https://nlnet.nl/). See [here](https://nlnet.nl/project/GoToSocial/#ack) for more details. The successful grant application is archived [here](https://github.com/superseriousbusiness/gotosocial/blob/main/archive/nlnet/2022-next-generation-internet-zero.md).
|
||||
|
||||
2024 Beta development of GoToSocial is being funded by an additional 50,000 EUR grant from the [NGI0 Entrust Fund](https://nlnet.nl/entrust/), via [NLnet](https://nlnet.nl/).
|
||||
|
||||
|
|
@ -559,7 +507,7 @@ Combined with the above crowdfunding sources, 2023 Alpha development of GoToSoci
|
|||
|
||||

|
||||
|
||||
GoToSocial is free software, licensed under the [GNU AGPL v3 LICENSE](https://codeberg.org/superseriousbusiness/gotosocial/src/branch/main/LICENSE). We encourage forking and changing the code, hacking around with it, and experimenting.
|
||||
GoToSocial is free software, licensed under the [GNU AGPL v3 LICENSE](https://github.com/superseriousbusiness/gotosocial/blob/main/LICENSE). We encourage forking and changing the code, hacking around with it, and experimenting.
|
||||
|
||||
See [here](https://www.gnu.org/licenses/why-affero-gpl.html) for the differences between AGPL versus GPL licensing, and [here](https://www.gnu.org/licenses/gpl-faq.html) for FAQ's about GPL licenses, including the AGPL.
|
||||
|
||||
|
|
|
|||
20
ROADMAP.md
|
|
@ -13,10 +13,10 @@ Big thank you to all of our [Open Collective](https://opencollective.com/gotosoc
|
|||
- [Beta Aims](#beta-aims)
|
||||
- [Timeline](#timeline)
|
||||
- [Mid 2023](#mid-2023)
|
||||
- [Mid/late 2023](#mid-late-2023)
|
||||
- [Mid/late 2023](#midlate-2023)
|
||||
- [Early 2024](#early-2024)
|
||||
- [BETA milestone](#beta-milestone)
|
||||
- [Remainder 2024 - early 2025](#remainder-2024-early-2025)
|
||||
- [Remainder 2024 - early 2025](#remainder-2024---early-2025)
|
||||
- [On the way out of BETA to STABLE RELEASE](#on-the-way-out-of-beta-to-stable-release)
|
||||
- [Wishlist](#wishlist)
|
||||
|
||||
|
|
@ -47,13 +47,13 @@ What follows is a rough timeline of features that will be implemented on the roa
|
|||
|
||||
### Mid 2023
|
||||
|
||||
- [x] **Hashtags** -- implement federating hashtags and viewing hashtags to allow users to discover posts that they might be interested in. (Done! https://codeberg.org/superseriousbusiness/gotosocial/pulls/2032).
|
||||
- [x] **Hashtags** -- implement federating hashtags and viewing hashtags to allow users to discover posts that they might be interested in. (Done! https://github.com/superseriousbusiness/gotosocial/pull/2032).
|
||||
|
||||
### Mid/late 2023
|
||||
|
||||
- [x] **Polls** -- implementing parsing, creating, and voting in polls. (Done! https://codeberg.org/superseriousbusiness/gotosocial/pulls/2330)
|
||||
- [x] **Mute posts/threads** -- opt-out of notifications for replies to a thread; no longer show a given post in your timeline. (Done! https://codeberg.org/superseriousbusiness/gotosocial/pulls/2278)
|
||||
- [x] **Limited peering/allowlists** -- allow instance admins to limit federation with other instances by default. (Done! https://codeberg.org/superseriousbusiness/gotosocial/pulls/2200)
|
||||
- [x] **Polls** -- implementing parsing, creating, and voting in polls. (Done! https://github.com/superseriousbusiness/gotosocial/pull/2330)
|
||||
- [x] **Mute posts/threads** -- opt-out of notifications for replies to a thread; no longer show a given post in your timeline. (Done! https://github.com/superseriousbusiness/gotosocial/pull/2278)
|
||||
- [x] **Limited peering/allowlists** -- allow instance admins to limit federation with other instances by default. (Done! https://github.com/superseriousbusiness/gotosocial/pull/2200)
|
||||
|
||||
### Early 2024
|
||||
|
||||
|
|
@ -71,12 +71,12 @@ These are provided in no specific order.
|
|||
- [x] **Filters v2** -- implement v2 of the filters API.
|
||||
- [x] **Mute accounts** -- mute accounts to prevent their posts showing up in your home timeline (optional: for limited period of time).
|
||||
- [x] **Non-replyable posts** -- design a non-replyable post path for GoToSocial based on https://github.com/mastodon/mastodon/issues/14762#issuecomment-1196889788; allow users to create non-replyable posts.
|
||||
- [x] **Block + allow list subscriptions** -- allow instance admins to subscribe their instance to domain block/allow lists.
|
||||
- [ ] **Block + allow list subscriptions** -- allow instance admins to subscribe their instance to plaintext domain block/allow lists (much of the work for this is already in place).
|
||||
- [x] **Direct conversation view** -- allow users to easily page through all direct-message conversations they're a part of.
|
||||
- [x] **Oauth token management** -- create / view / invalidate OAuth tokens via the settings panel.
|
||||
- [x] **Status EDIT support** -- edit statuses that you've created, without having to delete + redraft. Federate edits out properly.
|
||||
- [ ] **Oauth token management** -- create / view / invalidate OAuth tokens via the settings panel.
|
||||
- [ ] **Status EDIT support** -- edit statuses that you've created, without having to delete + redraft. Federate edits out properly.
|
||||
- [ ] **Fediverse relay support** -- publish posts to relays, pull posts from relays.
|
||||
- [x] **Two factor authentication (2fa)** -- allow users to enable 2FA for their account via the settings panel, enforce 2FA on login.
|
||||
- [ ] **Two factor authentication (2fa)** -- allow users to enable 2FA for their account via the settings panel, enforce 2FA on login.
|
||||
- [ ] **Moderation: Append content warning / mark-as-sensitive all content from an instance/account**.
|
||||
|
||||
More tbd!
|
||||
|
|
|
|||
|
|
@ -1 +0,0 @@
|
|||
Please email security issues to: admin@gotosocial.org
|
||||
|
|
@ -95,7 +95,7 @@ todo
|
|||
|
||||
### Friendica
|
||||
|
||||
Unsure: Friendica and GoToSocial still don't federate properly with one another (https://codeberg.org/superseriousbusiness/gotosocial/issues/169) so it's hard to test this.
|
||||
Unsure: Friendica and GoToSocial still don't federate properly with one another (https://github.com/superseriousbusiness/gotosocial/issues/169) so it's hard to test this.
|
||||
|
||||
## What should GoToSocial do?
|
||||
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@ GoToSocial
|
|||
|
||||
> Website / wiki
|
||||
|
||||
https://codeberg.org/superseriousbusiness/gotosocial / https://docs.gotosocial.org
|
||||
https://github.com/superseriousbusiness/gotosocial / https://docs.gotosocial.org
|
||||
|
||||
> Abstract: Can you explain the whole project and its expected outcome(s). (you have 1200 characters)
|
||||
|
||||
|
|
@ -87,8 +87,8 @@ Thirdly, we want to make GtS as customizable as possible by allowing admins to e
|
|||
|
||||
The main technical challenges we foresee on the project are:
|
||||
|
||||
1. Ensuring compatibility with other AP servers (see federation issues: https://codeberg.org/superseriousbusiness/gotosocial/issues?labels=378188).
|
||||
2. Ensuring compatibility with clients that use the Mastodon API (see client compatibility issues: https://codeberg.org/superseriousbusiness/gotosocial/issues?labels=378194).
|
||||
1. Ensuring compatibility with other AP servers (see here: https://github.com/superseriousbusiness/gotosocial/projects/4).
|
||||
2. Ensuring compatibility with clients that use the Mastodon API (see here: https://github.com/superseriousbusiness/gotosocial/projects/5).
|
||||
3. Designing nuanced federation safety features that allow instance admins to screen federation without totally breaking it. This will require careful design discussions and lots of testing.
|
||||
4. Implementing our own open-source http signature library with a reference implementation of the latest draft of the http signature proposal: https://httpwg.org/http-extensions/draft-ietf-httpbis-message-signatures.html.
|
||||
5. Writing + maintaining our own extensions to the AP protocol (see below).
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@ GoToSocial
|
|||
|
||||
> Website / wiki
|
||||
|
||||
https://codeberg.org/superseriousbusiness/gotosocial / https://docs.gotosocial.org
|
||||
https://github.com/superseriousbusiness/gotosocial / https://docs.gotosocial.org
|
||||
|
||||
> Abstract: Can you explain the whole project and its expected outcome(s). (you have 1200 characters)
|
||||
|
||||
|
|
@ -20,7 +20,7 @@ GtS emphasizes user safety and privacy. Unlike other AP servers, it always requi
|
|||
|
||||
GtS values ease of deployment and maintenance; this means low system requirements, simple configuration, minimal external dependencies, and clear documentation. GtS makes it easy + affordable for self-hosting newcomers to set up a Fediverse server on low- (or even solar-) powered equipment they might have lying around at home.
|
||||
|
||||
GtS began development in Feb 2021. It is still in Alpha, and we hope to use NLNet funding to bring it up to the Beta phase. The project roadmap (https://codeberg.org/superseriousbusiness/gotosocial/src/branch/main/ROADMAP.md) gives more information on what we have planned.
|
||||
GtS began development in Feb 2021. It is still in Alpha, and we hope to use NLNet funding to bring it up to the Beta phase. The project roadmap (https://github.com/superseriousbusiness/gotosocial/blob/main/ROADMAP.md) gives more information on what we have planned.
|
||||
|
||||
> Have you been involved with projects or organisations relevant to this project before? And if so, can you tell us a bit about your contributions? (Optional) This can help us determine if you are the right person to undertake this effort.
|
||||
|
||||
|
|
@ -45,7 +45,7 @@ Aside from GoToSocial, I've also made small PRs upstream to the ActivityPub libr
|
|||
|
||||
Currently, GoToSocial receives about €22/week from LiberaPay donations - https://liberapay.com/gotosocial. I have been paying my own costs for working on the project from my savings, which is unfortunately not sustainable for a lot longer.
|
||||
|
||||
The requested NLNet budget will be used to fund the remaining Alpha portion of development, and bring GoToSocial into the Beta phase (see the roadmap - https://codeberg.org/superseriousbusiness/gotosocial/src/branch/main/ROADMAP.md). In practical terms, this means paying myself to work full time on the project for one year, and paying for contributions from other developers as well.
|
||||
The requested NLNet budget will be used to fund the remaining Alpha portion of development, and bring GoToSocial into the Beta phase (see the roadmap - https://github.com/superseriousbusiness/gotosocial/blob/main/ROADMAP.md). In practical terms, this means paying myself to work full time on the project for one year, and paying for contributions from other developers as well.
|
||||
|
||||
To pay my living costs + rent I need to make about €2,000/month after tax, working full time. In Belgium, that equates to about €3,000/month, which is €36,000 for one year of work. Naively calculated at 40 hours / week, that's €18.75 per hour.
|
||||
|
||||
|
|
@ -83,8 +83,8 @@ Thirdly, we want to make GtS as customizable as possible by allowing admins to e
|
|||
|
||||
The main technical challenges we foresee on the project are:
|
||||
|
||||
1. Ensuring compatibility with other AP servers (see federation issues: https://codeberg.org/superseriousbusiness/gotosocial/issues?labels=378188).
|
||||
2. Ensuring compatibility with clients that use the Mastodon API (see client compatibility issues: https://codeberg.org/superseriousbusiness/gotosocial/issues?labels=378194).
|
||||
1. Ensuring compatibility with other AP servers (see here: https://github.com/superseriousbusiness/gotosocial/projects/4).
|
||||
2. Ensuring compatibility with clients that use the Mastodon API (see here: https://github.com/superseriousbusiness/gotosocial/projects/5).
|
||||
3. Designing nuanced federation safety features that allow instance admins to screen federation without totally breaking it. This will require careful design discussions and lots of testing.
|
||||
4. Implementing our own open-source http signature library with a reference implementation of the latest draft of the http signature proposal: https://httpwg.org/http-extensions/draft-ietf-httpbis-message-signatures.html.
|
||||
5. Writing + maintaining our own extensions to the AP protocol (see below).
|
||||
|
|
|
|||
|
|
@ -1,123 +0,0 @@
|
|||
# NLnet Grant Application - NGI Zero Commons 2025
|
||||
|
||||
This document is the application on behalf of GoToSocial for funding from the [NLnet](https://nlnet.nl) [NGI Zero Commons fund](https://nlnet.nl/commonsfund/), April 2025. See [here](https://nlnet.nl/propose/).
|
||||
|
||||
## General Project Information
|
||||
|
||||
> Project Name
|
||||
|
||||
GoToSocial
|
||||
|
||||
> Website / wiki
|
||||
|
||||
https://codeberg.org/superseriousbusiness/gotosocial / https://docs.gotosocial.org
|
||||
|
||||
> Abstract: Can you explain the whole project and its expected outcome(s). (you have 1200 characters)
|
||||
|
||||
GoToSocial (GtS) is an ActivityPub social network server, which provides a lightweight, simple entryway into Fediverse hosting. It is comparable to (but distinct from) projects such as Mastodon, Friendica, and PixelFed.
|
||||
|
||||
GtS emphasizes user safety and privacy. Unlike other AP servers, it always requires http signatures, and makes a strong differentiation between 'public' and other kinds of posts. It also makes it very easy for admins to block instances they don't want to interact with, by allowing them to subscribe to block lists or allow lists, and to import blocks, ensuring that users stay safe.
|
||||
|
||||
GtS values ease of deployment and maintenance; this means low system requirements, simple configuration, minimal external dependencies, and clear documentation. GtS makes it easy + affordable for self-hosting newcomers to set up a Fediverse server on low- (or even solar-) powered equipment they might have lying around at home.
|
||||
|
||||
GtS began development in Feb 2021, and entered Beta in 2024. We hope to use NLnet funding to continue tuning performance and adding features as we work towards a 1.0 release.
|
||||
|
||||
> Have you been involved with projects or organisations relevant to this project before? And if so, can you tell us a bit about your contributions? (Optional) This can help us determine if you are the right person to undertake this effort. (max 2500 characters)
|
||||
|
||||
I have been working on GoToSocial since the beginning of the project, first independently, paying myself from my savings, and then thanks to two previous grants from NLnet. My colleague Kim has a similar trajectory, as they now work full time on the project, again thanks to NLnet.
|
||||
|
||||
Over the last years we have put many thousands of hours of work into the project: writing code and documentation, fixing bugs, communicating with contributors and doing code review, deploying infrastructure for project builds and discussion, doing project planning, and answering user questions.
|
||||
|
||||
Aside from our work on GoToSocial, we also maintain a fork of the Activity library (https://codeberg.org/superseriousbusiness/activity), a fork of the standalone Mastodon frontend customized for GoToSocial (https://codeberg.org/superseriousbusiness/masto-fe-standalone, deployed at https://masto-fe.superseriousbusiness.org), and Kim in particular maintains a large amount of libraries used by the project (https://codeberg.org/gruf), particularly go-ffmpreg (https://codeberg.org/gruf/go-ffmpreg).
|
||||
|
||||
## Requested Support
|
||||
|
||||
> Explain what the requested budget will be used for?
|
||||
> Does the project have other funding sources, both past and present?
|
||||
> (If you want, you can in addition attach a budget at the bottom of the form)
|
||||
> Explain costs for hardware, human labor (including rates used), travel cost to technical meetings, etc. (max 2500 characters, be concise)
|
||||
|
||||
GoToSocial has received two NLnet grants previously, one in 2022-2023, for 50k euros, and another one in 2024-2025, for 75k euros, which we shared between the two of us. These grants went towards paying living costs for myself and Kim (rent, groceries, utilities, taxes, etc), while we both worked full time on the project.
|
||||
|
||||
For our first grant we underbudgeted our own costs and ended up underpaying ourselves. We better estimated the second grant, but still had some issues doing more work than we budgeted for, taking account of bug fixes, extra features, and release coordination.
|
||||
|
||||
With the benefit of experience, this time we intend to budget more sensibly so that we don't end up going into our overdrafts before the end of each milestone, hence we are asking for a larger amount of funding: 100k euros in total, or 50k euros each per year. This amount of money is comparable to the rate for a mid/senior-level developer in the countries we live in, and should allow us to pay our costs without panic.
|
||||
|
||||
Happily, we receive a decent amount of money per month via OpenCollective (https://opencollective.com/gotosocial), which allows us to pay for costs (Greenhost.net) for our CI/CD + snapshot distribution server. It also allows us to pay our freelance colleague f0x for the contributions they are able to make when school is not too busy. As such, NLnet money does not need to be used for anything besides mine and Kim's living costs.
|
||||
|
||||
This year, we would like to use the NGI Zero Commons grant to fund development of the following efforts (more tbd):
|
||||
|
||||
- Add functionality to allow users and admins to configure cleanup of old statuses and accounts from the database, to keep database sizes smaller.
|
||||
- Implement better threading support when statuses are deleted (ie., store + show status tombstones).
|
||||
- Improve search performance and add full-text-search (SQLite, Postgres).
|
||||
- Add additional in-memory caches for frontend object types (statuses, notifications, etc) to reduce database calls and improve response times.
|
||||
- Add support for subscribing to relays, and allowing GoToSocial itself to act as a relay, improving connectivity with other instances.
|
||||
- Add additional federation controls (silence/mute/limit instances).
|
||||
- Add an opt-in profile directory to make it easier to discover accounts on an instance.
|
||||
- Implement admin panel section to track unreachable instances, so that admins can tell whether another instance has shut down, and take appropriate action.
|
||||
|
||||
> Compare your own project with existing or historical efforts
|
||||
> E.g. what is new, more thorough or otherwise different. (max 4000 characters, be concise)
|
||||
|
||||
ActivityPub is now a popular protocol, with a proliferation of AP implementations like Mastodon, Akkoma, Lemmy, Misskey (and its many forks), Pixelfed, WriteFreely, Wordpress, and more, each with its own focus and purpose. As strong as many of these implementations are, however, they are not without their downsides.
|
||||
|
||||
For instance, Mastodon and Pixelfed both lean more towards replicating existing corporate social media efforts (Twitter and Instagram respectively), which is offputting for many users. These two implementations are also complex to install and maintain, which puts many would-be admins off hosting their own servers, and leads to a concentration of users on developer-run servers like mastodon.social and pixelfed.social, which breaks the promise of decentralization.
|
||||
|
||||
Other ActivityPub-enabled microblogging softwares like Honk and Snac2 have fewer moving parts and lower system requirements, which has led to a surge of deployments of Snac2 in particular. However, their implementation of the Mastodon client API (the de-facto client API of the fediverse, for better or worse), misses some features, and the barebones admin functionality is not user-friendly for people unaccustomed to using the command line.
|
||||
|
||||
In addition, some other fediverse projects have a heavy front-end UI which results in a poor experience on low-bandwidth connections or low-powered devices.
|
||||
|
||||
GoToSocial's continued aim is to strike a balance between featureful but fairly resource-intensive AP implementations like Mastodon, and lighter and simpler AP implementations like Snac2 and Honk.
|
||||
|
||||
Firstly, GtS is small, easy to run, and very well documented. It uses about 200-300MiB of memory on average, so it can be deployed on tiny VPSs for cheap, and on single-board computers. It has no dependencies on things like ffmpeg or on-system SQLite, as everything is virtualized inside the single binary using WASM/Wazero. This means that people who want to run GoToSocial don't need to install or maintain anything else on the host, and it is very easy for third parties like Yunohost to package and distribute.
|
||||
|
||||
Secondly, the admin/settings panel offers admins and users the ability to easily customize their profiles and adjust the way that their instance looks, feels, and federates, and to handle day-to-day admin tasks like reviewing reports, blocking or allowing other instances, etc. The web view of profiles is rendered in simple HTML + CSS; Javascript is not required, but is used for progressive enhancement if available. This makes it relatively easy to view a GoToSocial profile on a mobile device with poor connection, on a lower-end laptop etc.
|
||||
|
||||
Thirdly, it provides strong safety features thanks to strict block implementation, always-on HTTP signature authentication, interaction controls, and allowing users to choose what visibility of level of posts can be viewed on their profile. The allowlist subscription functionality we added in 2024 is also critical here, as it allows groups of instances to easily federate only with each other, forming "islands" that can be more easily moderated than fully open federation.
|
||||
|
||||
Fourthly, we have been -- and continue to be -- fastidious with our Mastodon client API implementation, which means that GoToSocial can be used with a wide variety of clients that provide different experiences to the user. It even works with apps for Pixelfed, so user's can use a GoToSocial account for 'gram-style media-only posting.
|
||||
|
||||
> What are significant technical challenges you expect to solve during the project, if any? (optional but recommended, max 5000 characters)
|
||||
|
||||
Many of the technical challenges we expect to overcome during this development period are specific to the development efforts we will undertake as part of this grant:
|
||||
|
||||
- Status cleanup: Ensure that cleanup processes are capable of being regularly scheduled asynchronously, while not consuming all available server resources (with what will likely involve scanning the entirety of our largest database table!). This may require some clever indexing and/or marking of statuses as expirable in advance.
|
||||
- Status tombstones: figure out whether we can write a migration to retroactively rethread old statuses that have become unlinked due to deletes.
|
||||
- Relay support: figure out whether adding support for relay mode will require a separate relay binary, and if so, refactor sections of the codebase into libraries that can be shared by that binary.
|
||||
- Relay support: make sure GoToSocial can subscribe to both existing relay services, as well as GoToSocial relays (this will probably involve lots of dipping into the codebases of existing relay services like fedi buzz, to figure out what they're doing). And vice versa: ensure that existing fedi implementations with relay support can subscribe to GoToSocial relays.
|
||||
- Relay support: make sure that DB sizes and memory usage don't become too burdensome given the amount of statuses that relays are likely to process compared to a vanilla instance.
|
||||
- Profile directory: ensure "discoverable" flag is respected; optimize required new database queries to ensure they use existing indexes (or figure out which new ones need to be created).
|
||||
- Search support: ensure that the same functionality and performance is offered by both Postgres and SQLite; possibly refactor our database wrappers and migration code for this.
|
||||
- Unreachable instances: develop a reasonable heuristic to determine whether an instance is unreachable; work out the best way of storing this information in the database and presenting it to admins via the settings panel.
|
||||
|
||||
Other technical challenges we will (continue to) address in the near future are not related to any specific milestone task:
|
||||
|
||||
- Ensure continued compatibility of GoToSocial with other fedi software projects.
|
||||
- Ensure continued compatibility of GoToSocial with Mastodon API client apps.
|
||||
- Refactor old parts of the codebase to increase readability and remove bugs.
|
||||
- Make performance tweaks to the codebase wherever necessary (reduce CPU usage, improve memory usage).
|
||||
- Increase coverage of our test suites.
|
||||
- Continue to support seamless database migration from old versions of GoToSocial to newer ones.
|
||||
- Refactor some of the frontend settings panel code to maximize code reuse and minimize compiled javascript size, before adding lots of new functionality.
|
||||
- Move our CI/CD infrastructure and code repository from Github to Codeberg with minimal disruption to our work.
|
||||
|
||||
> Describe the ecosystem of the project, and how you will engage with relevant actors and promote the outcomes. E.g. which actors will you involve? Who should run or deploy your solution to make it a success? (max 2500 characters, be concise)
|
||||
|
||||
Much of the work we do involves debugging and solving interoperability issues with other federated softwares, which requires keeping communication channels open with the maintainers of those, and figuring out who needs to change what in order for the issue to be resolved. We've done that a lot over the last year or so:
|
||||
|
||||
- Fixed interop with Bandwagon: https://github.com/EmissarySocial/bandwagon/issues/152
|
||||
- Fixed interop with Iceshrimp: https://codeberg.org/superseriousbusiness/gotosocial/issues/1947
|
||||
- Coordinated interop with Mastodon: https://codeberg.org/superseriousbusiness/gotosocial/pulls/3703
|
||||
- Fixed federation with Gancio: https://codeberg.org/superseriousbusiness/gotosocial/issues/3875
|
||||
- Alerted Pixelfed of AP serialization issues: https://github.com/pixelfed/pixelfed/issues/5642
|
||||
- Cajoled Bluesky into adding user-agent headers: https://github.com/bluesky-social/atproto/issues/3504
|
||||
- Help out Writefreely with http signature request issues: https://github.com/writefreely/writefreely/issues/661#issuecomment-1951367449
|
||||
- Debug federation with Lemmy along with one of the Lemmy devs: https://codeberg.org/superseriousbusiness/gotosocial/issues/2697
|
||||
|
||||
For GoToSocial-specific extensions to ActivityPub, we've also diligently documented what we've done so far, and exposed a GoToSocial namespace so that remote softwares can easily incorporate GtS extensions if they want to: https://docs.gotosocial.org/en/latest/federation/interaction_policy/, https://gotosocial.org/ns.
|
||||
|
||||
This is all part and parcel of our goal for GoToSocial to be a "good citizen" in terms of how it federates, and how we fit into the larger ActivityPub microblogging ecosystem. We intend to keep doing this!
|
||||
|
||||
## Attachments
|
||||
|
||||
> Attachments: add any additional information about the project that may help us to gain more insight into the proposed effort, for instance a more detailed task description, a justification of costs or relevant endorsements. Attachments should only contain background information, please make sure that the proposal without attachments is self-contained and concise. Don't waste too much time on this. Really.
|
||||
|
|
@ -1,22 +0,0 @@
|
|||
// 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/>.
|
||||
|
||||
package main
|
||||
|
||||
import "code.superseriousbusiness.org/gotosocial/internal/id"
|
||||
|
||||
func main() { println(id.NewULID()) }
|
||||
|
|
@ -24,39 +24,23 @@ import (
|
|||
"text/tabwriter"
|
||||
"time"
|
||||
|
||||
"code.superseriousbusiness.org/gotosocial/cmd/gotosocial/action"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/config"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/db/bundb"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/gtsmodel"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/log"
|
||||
userprocessor "code.superseriousbusiness.org/gotosocial/internal/processing/user"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/state"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/util"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/validate"
|
||||
"github.com/superseriousbusiness/gotosocial/cmd/gotosocial/action"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/config"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/db/bundb"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/gtsmodel"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/log"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/state"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/util"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/validate"
|
||||
"golang.org/x/crypto/bcrypt"
|
||||
)
|
||||
|
||||
var (
|
||||
// check function conformance
|
||||
_ action.GTSAction = Create
|
||||
_ action.GTSAction = List
|
||||
_ action.GTSAction = Confirm
|
||||
_ action.GTSAction = Promote
|
||||
_ action.GTSAction = Demote
|
||||
_ action.GTSAction = Enable
|
||||
_ action.GTSAction = Disable
|
||||
_ action.GTSAction = Password
|
||||
)
|
||||
|
||||
func initState(ctx context.Context) (*state.State, error) {
|
||||
var state state.State
|
||||
state.Caches.Init()
|
||||
if err := state.Caches.Start(); err != nil {
|
||||
return nil, fmt.Errorf("error starting caches: %w", err)
|
||||
}
|
||||
state.Caches.Start()
|
||||
|
||||
// Only set state DB connection.
|
||||
// Don't need Actions or Workers for this (yet).
|
||||
// Set the state DB connection
|
||||
dbConn, err := bundb.NewBunDBService(ctx, &state)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("error creating dbConn: %w", err)
|
||||
|
|
@ -74,7 +58,7 @@ func stopState(state *state.State) error {
|
|||
|
||||
// Create creates a new account and user
|
||||
// in the database using the provided flags.
|
||||
func Create(ctx context.Context) error {
|
||||
var Create action.GTSAction = func(ctx context.Context) error {
|
||||
state, err := initState(ctx)
|
||||
if err != nil {
|
||||
return err
|
||||
|
|
@ -131,7 +115,7 @@ func Create(ctx context.Context) error {
|
|||
}
|
||||
|
||||
// List returns all existing local accounts.
|
||||
func List(ctx context.Context) error {
|
||||
var List action.GTSAction = func(ctx context.Context) error {
|
||||
state, err := initState(ctx)
|
||||
if err != nil {
|
||||
return err
|
||||
|
|
@ -169,7 +153,7 @@ func List(ctx context.Context) error {
|
|||
|
||||
// Confirm sets a user to Approved, sets Email to the current
|
||||
// UnconfirmedEmail value, and sets ConfirmedAt to now.
|
||||
func Confirm(ctx context.Context) error {
|
||||
var Confirm action.GTSAction = func(ctx context.Context) error {
|
||||
state, err := initState(ctx)
|
||||
if err != nil {
|
||||
return err
|
||||
|
|
@ -211,7 +195,7 @@ func Confirm(ctx context.Context) error {
|
|||
}
|
||||
|
||||
// Promote sets admin + moderator flags on a user to true.
|
||||
func Promote(ctx context.Context) error {
|
||||
var Promote action.GTSAction = func(ctx context.Context) error {
|
||||
state, err := initState(ctx)
|
||||
if err != nil {
|
||||
return err
|
||||
|
|
@ -248,7 +232,7 @@ func Promote(ctx context.Context) error {
|
|||
}
|
||||
|
||||
// Demote sets admin + moderator flags on a user to false.
|
||||
func Demote(ctx context.Context) error {
|
||||
var Demote action.GTSAction = func(ctx context.Context) error {
|
||||
state, err := initState(ctx)
|
||||
if err != nil {
|
||||
return err
|
||||
|
|
@ -285,7 +269,7 @@ func Demote(ctx context.Context) error {
|
|||
}
|
||||
|
||||
// Disable sets Disabled to true on a user.
|
||||
func Disable(ctx context.Context) error {
|
||||
var Disable action.GTSAction = func(ctx context.Context) error {
|
||||
state, err := initState(ctx)
|
||||
if err != nil {
|
||||
return err
|
||||
|
|
@ -321,7 +305,7 @@ func Disable(ctx context.Context) error {
|
|||
}
|
||||
|
||||
// Enable sets Disabled to false on a user.
|
||||
func Enable(ctx context.Context) error {
|
||||
var Enable action.GTSAction = func(ctx context.Context) error {
|
||||
state, err := initState(ctx)
|
||||
if err != nil {
|
||||
return err
|
||||
|
|
@ -357,7 +341,7 @@ func Enable(ctx context.Context) error {
|
|||
}
|
||||
|
||||
// Password sets the password of target account.
|
||||
func Password(ctx context.Context) error {
|
||||
var Password action.GTSAction = func(ctx context.Context) error {
|
||||
state, err := initState(ctx)
|
||||
if err != nil {
|
||||
return err
|
||||
|
|
@ -396,47 +380,8 @@ func Password(ctx context.Context) error {
|
|||
}
|
||||
|
||||
user.EncryptedPassword = string(encryptedPassword)
|
||||
log.Info(ctx, "Updating password; you must restart the server to use the new password.")
|
||||
return state.DB.UpdateUser(
|
||||
ctx, user,
|
||||
"encrypted_password",
|
||||
)
|
||||
}
|
||||
|
||||
// Disable2FA disables 2FA for target account.
|
||||
func Disable2FA(ctx context.Context) error {
|
||||
state, err := initState(ctx)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
defer func() {
|
||||
// Ensure state gets stopped on return.
|
||||
if err := stopState(state); err != nil {
|
||||
log.Error(ctx, err)
|
||||
}
|
||||
}()
|
||||
|
||||
username := config.GetAdminAccountUsername()
|
||||
if err := validate.Username(username); err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
account, err := state.DB.GetAccountByUsernameDomain(ctx, username, "")
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
user, err := state.DB.GetUserByAccountID(ctx, account.ID)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
err = userprocessor.TwoFactorDisable(ctx, state, user)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
fmt.Printf("2fa disabled\n")
|
||||
return nil
|
||||
}
|
||||
|
|
|
|||
|
|
@ -18,181 +18,95 @@
|
|||
package media
|
||||
|
||||
import (
|
||||
"bufio"
|
||||
"context"
|
||||
"errors"
|
||||
"fmt"
|
||||
"os"
|
||||
"path"
|
||||
|
||||
"code.superseriousbusiness.org/gotosocial/cmd/gotosocial/action"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/config"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/db"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/db/bundb"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/gtsmodel"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/log"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/paging"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/state"
|
||||
"codeberg.org/gruf/go-byteutil"
|
||||
"codeberg.org/gruf/go-fastpath/v2"
|
||||
"github.com/superseriousbusiness/gotosocial/cmd/gotosocial/action"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/config"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/db"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/db/bundb"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/gtsmodel"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/log"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/paging"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/state"
|
||||
)
|
||||
|
||||
// check function conformance.
|
||||
var _ action.GTSAction = ListAttachments
|
||||
var _ action.GTSAction = ListEmojis
|
||||
|
||||
// ListAttachments lists local, remote, or all attachment paths.
|
||||
func ListAttachments(ctx context.Context) error {
|
||||
list, err := setupList(ctx)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
defer func() {
|
||||
// Ensure lister gets shutdown on exit.
|
||||
if err := list.shutdown(); err != nil {
|
||||
log.Errorf(ctx, "error shutting down: %v", err)
|
||||
}
|
||||
}()
|
||||
|
||||
// List attachment media paths from db.
|
||||
return list.ListAttachmentPaths(ctx)
|
||||
}
|
||||
|
||||
// ListEmojis lists local, remote, or all emoji filepaths.
|
||||
func ListEmojis(ctx context.Context) error {
|
||||
list, err := setupList(ctx)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
defer func() {
|
||||
// Ensure lister gets shutdown on exit.
|
||||
if err := list.shutdown(); err != nil {
|
||||
log.Errorf(ctx, "error shutting down: %v", err)
|
||||
}
|
||||
}()
|
||||
|
||||
// List emoji media paths from db.
|
||||
return list.ListEmojiPaths(ctx)
|
||||
}
|
||||
|
||||
type list struct {
|
||||
dbService db.DB
|
||||
state *state.State
|
||||
page paging.Page
|
||||
localOnly bool
|
||||
remoteOnly bool
|
||||
out *bufio.Writer
|
||||
}
|
||||
|
||||
func (l *list) ListAttachmentPaths(ctx context.Context) error {
|
||||
// Page reused for iterative
|
||||
// attachment queries, with
|
||||
// predefined limit.
|
||||
var page paging.Page
|
||||
page.Limit = 500
|
||||
|
||||
// Storage base path, used for path building.
|
||||
basePath := config.GetStorageLocalBasePath()
|
||||
// Get a list of attachment using a custom filter
|
||||
func (l *list) GetAllAttachmentPaths(ctx context.Context, filter func(*gtsmodel.MediaAttachment) string) ([]string, error) {
|
||||
res := make([]string, 0, 100)
|
||||
|
||||
for {
|
||||
// Get next page of media attachments up to max ID.
|
||||
medias, err := l.state.DB.GetAttachments(ctx, &page)
|
||||
// Get the next page of media attachments up to max ID.
|
||||
attachments, err := l.dbService.GetAttachments(ctx, &l.page)
|
||||
if err != nil && !errors.Is(err, db.ErrNoEntries) {
|
||||
return fmt.Errorf("failed to fetch media from database: %w", err)
|
||||
return nil, fmt.Errorf("failed to retrieve media metadata from database: %w", err)
|
||||
}
|
||||
|
||||
// Get current max ID.
|
||||
maxID := page.Max.Value
|
||||
maxID := l.page.Max.Value
|
||||
|
||||
// If no media or the same group is returned, we reached end.
|
||||
if len(medias) == 0 || maxID == medias[len(medias)-1].ID {
|
||||
// If no attachments or the same group is returned, we reached the end.
|
||||
if len(attachments) == 0 || maxID == attachments[len(attachments)-1].ID {
|
||||
break
|
||||
}
|
||||
|
||||
// Use last ID as the next 'maxID'.
|
||||
maxID = medias[len(medias)-1].ID
|
||||
page.Max.Value = maxID
|
||||
// Use last ID as the next 'maxID' value.
|
||||
maxID = attachments[len(attachments)-1].ID
|
||||
l.page.Max = paging.MaxID(maxID)
|
||||
|
||||
switch {
|
||||
case l.localOnly:
|
||||
// Only print local media paths.
|
||||
for _, media := range medias {
|
||||
if media.RemoteURL == "" {
|
||||
printMediaPaths(basePath, media)
|
||||
}
|
||||
}
|
||||
|
||||
case l.remoteOnly:
|
||||
// Only print remote media paths.
|
||||
for _, media := range medias {
|
||||
if media.RemoteURL != "" {
|
||||
printMediaPaths(basePath, media)
|
||||
}
|
||||
}
|
||||
|
||||
default:
|
||||
// Print all known media paths.
|
||||
for _, media := range medias {
|
||||
printMediaPaths(basePath, media)
|
||||
for _, a := range attachments {
|
||||
v := filter(a)
|
||||
if v != "" {
|
||||
res = append(res, v)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return nil
|
||||
return res, nil
|
||||
}
|
||||
|
||||
func (l *list) ListEmojiPaths(ctx context.Context) error {
|
||||
// Page reused for iterative
|
||||
// attachment queries, with
|
||||
// predefined limit.
|
||||
var page paging.Page
|
||||
page.Limit = 500
|
||||
|
||||
// Storage base path, used for path building.
|
||||
basePath := config.GetStorageLocalBasePath()
|
||||
|
||||
// Get a list of emojis using a custom filter
|
||||
func (l *list) GetAllEmojisPaths(ctx context.Context, filter func(*gtsmodel.Emoji) string) ([]string, error) {
|
||||
res := make([]string, 0, 100)
|
||||
for {
|
||||
// Get the next page of emoji media up to max ID.
|
||||
emojis, err := l.state.DB.GetEmojis(ctx, &page)
|
||||
attachments, err := l.dbService.GetEmojis(ctx, &l.page)
|
||||
if err != nil && !errors.Is(err, db.ErrNoEntries) {
|
||||
return fmt.Errorf("failed to fetch emojis from database: %w", err)
|
||||
return nil, fmt.Errorf("failed to retrieve media metadata from database: %w", err)
|
||||
}
|
||||
|
||||
// Get current max ID.
|
||||
maxID := page.Max.Value
|
||||
maxID := l.page.Max.Value
|
||||
|
||||
// If no emojis or the same group is returned, we reached end.
|
||||
if len(emojis) == 0 || maxID == emojis[len(emojis)-1].ID {
|
||||
// If no attachments or the same group is returned, we reached the end.
|
||||
if len(attachments) == 0 || maxID == attachments[len(attachments)-1].ID {
|
||||
break
|
||||
}
|
||||
|
||||
// Use last ID as the next 'maxID'.
|
||||
maxID = emojis[len(emojis)-1].ID
|
||||
page.Max.Value = maxID
|
||||
// Use last ID as the next 'maxID' value.
|
||||
maxID = attachments[len(attachments)-1].ID
|
||||
l.page.Max = paging.MaxID(maxID)
|
||||
|
||||
switch {
|
||||
case l.localOnly:
|
||||
// Only print local emoji paths.
|
||||
for _, emoji := range emojis {
|
||||
if emoji.ImageRemoteURL == "" {
|
||||
printEmojiPaths(basePath, emoji)
|
||||
}
|
||||
}
|
||||
|
||||
case l.remoteOnly:
|
||||
// Only print remote emoji paths.
|
||||
for _, emoji := range emojis {
|
||||
if emoji.ImageRemoteURL != "" {
|
||||
printEmojiPaths(basePath, emoji)
|
||||
}
|
||||
}
|
||||
|
||||
default:
|
||||
// Print all known emoji paths.
|
||||
for _, emoji := range emojis {
|
||||
printEmojiPaths(basePath, emoji)
|
||||
for _, a := range attachments {
|
||||
v := filter(a)
|
||||
if v != "" {
|
||||
res = append(res, v)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return nil
|
||||
return res, nil
|
||||
}
|
||||
|
||||
func setupList(ctx context.Context) (*list, error) {
|
||||
|
|
@ -210,84 +124,146 @@ func setupList(ctx context.Context) (*list, error) {
|
|||
)
|
||||
}
|
||||
|
||||
// Initialize caches.
|
||||
state.Caches.Init()
|
||||
state.Caches.Start()
|
||||
|
||||
// Ensure background cache tasks are running.
|
||||
if err := state.Caches.Start(); err != nil {
|
||||
return nil, fmt.Errorf("error starting caches: %w", err)
|
||||
}
|
||||
|
||||
var err error
|
||||
|
||||
// Only set state DB connection.
|
||||
// Don't need Actions or Workers for this.
|
||||
state.DB, err = bundb.NewBunDBService(ctx, &state)
|
||||
dbService, err := bundb.NewBunDBService(ctx, &state)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("error creating dbservice: %w", err)
|
||||
}
|
||||
state.DB = dbService
|
||||
|
||||
return &list{
|
||||
dbService: dbService,
|
||||
state: &state,
|
||||
page: paging.Page{Limit: 200},
|
||||
localOnly: localOnly,
|
||||
remoteOnly: remoteOnly,
|
||||
out: bufio.NewWriter(os.Stdout),
|
||||
}, nil
|
||||
}
|
||||
|
||||
func (l *list) shutdown() error {
|
||||
err := l.state.DB.Close()
|
||||
l.out.Flush()
|
||||
err := l.dbService.Close()
|
||||
l.state.Caches.Stop()
|
||||
return err
|
||||
}
|
||||
|
||||
// reusable path building buffer,
|
||||
// only usable here as we're not
|
||||
// performing concurrent writes.
|
||||
var pb fastpath.Builder
|
||||
|
||||
// reusable string output buffer,
|
||||
// only usable here as we're not
|
||||
// performing concurrent writes.
|
||||
var outbuf byteutil.Buffer
|
||||
|
||||
func printMediaPaths(basePath string, media *gtsmodel.MediaAttachment) {
|
||||
// Append file path if present.
|
||||
if media.File.Path != "" {
|
||||
path := pb.Join(basePath, media.File.Path)
|
||||
_, _ = outbuf.WriteString(path + "\n")
|
||||
// ListAttachments lists local, remote, or all attachment paths.
|
||||
var ListAttachments action.GTSAction = func(ctx context.Context) error {
|
||||
list, err := setupList(ctx)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
// Append thumb path if present.
|
||||
if media.Thumbnail.Path != "" {
|
||||
path := pb.Join(basePath, media.Thumbnail.Path)
|
||||
_, _ = outbuf.WriteString(path + "\n")
|
||||
defer func() {
|
||||
// Ensure lister gets shutdown on exit.
|
||||
if err := list.shutdown(); err != nil {
|
||||
log.Error(ctx, err)
|
||||
}
|
||||
}()
|
||||
|
||||
var (
|
||||
mediaPath = config.GetStorageLocalBasePath()
|
||||
filter func(*gtsmodel.MediaAttachment) string
|
||||
)
|
||||
|
||||
switch {
|
||||
case list.localOnly:
|
||||
filter = func(m *gtsmodel.MediaAttachment) string {
|
||||
if m.RemoteURL != "" {
|
||||
// Remote, not
|
||||
// interested.
|
||||
return ""
|
||||
}
|
||||
|
||||
return path.Join(mediaPath, m.File.Path)
|
||||
}
|
||||
|
||||
case list.remoteOnly:
|
||||
filter = func(m *gtsmodel.MediaAttachment) string {
|
||||
if m.RemoteURL == "" {
|
||||
// Local, not
|
||||
// interested.
|
||||
return ""
|
||||
}
|
||||
|
||||
return path.Join(mediaPath, m.File.Path)
|
||||
}
|
||||
|
||||
default:
|
||||
filter = func(m *gtsmodel.MediaAttachment) string {
|
||||
return path.Join(mediaPath, m.File.Path)
|
||||
}
|
||||
}
|
||||
|
||||
// Only write if any
|
||||
// string was prepared.
|
||||
if outbuf.Len() > 0 {
|
||||
_, _ = os.Stdout.Write(outbuf.B)
|
||||
outbuf.Reset()
|
||||
attachments, err := list.GetAllAttachmentPaths(ctx, filter)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
for _, a := range attachments {
|
||||
_, _ = list.out.WriteString(a + "\n")
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func printEmojiPaths(basePath string, emoji *gtsmodel.Emoji) {
|
||||
// Append image path if present.
|
||||
if emoji.ImagePath != "" {
|
||||
path := pb.Join(basePath, emoji.ImagePath)
|
||||
_, _ = outbuf.WriteString(path + "\n")
|
||||
// ListEmojis lists local, remote, or all emoji filepaths.
|
||||
var ListEmojis action.GTSAction = func(ctx context.Context) error {
|
||||
list, err := setupList(ctx)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
// Append static path if present.
|
||||
if emoji.ImageStaticPath != "" {
|
||||
path := pb.Join(basePath, emoji.ImageStaticPath)
|
||||
_, _ = outbuf.WriteString(path + "\n")
|
||||
defer func() {
|
||||
// Ensure lister gets shutdown on exit.
|
||||
if err := list.shutdown(); err != nil {
|
||||
log.Error(ctx, err)
|
||||
}
|
||||
}()
|
||||
|
||||
var (
|
||||
mediaPath = config.GetStorageLocalBasePath()
|
||||
filter func(*gtsmodel.Emoji) string
|
||||
)
|
||||
|
||||
switch {
|
||||
case list.localOnly:
|
||||
filter = func(e *gtsmodel.Emoji) string {
|
||||
if e.ImageRemoteURL != "" {
|
||||
// Remote, not
|
||||
// interested.
|
||||
return ""
|
||||
}
|
||||
|
||||
return path.Join(mediaPath, e.ImagePath)
|
||||
}
|
||||
|
||||
case list.remoteOnly:
|
||||
filter = func(e *gtsmodel.Emoji) string {
|
||||
if e.ImageRemoteURL == "" {
|
||||
// Local, not
|
||||
// interested.
|
||||
return ""
|
||||
}
|
||||
|
||||
return path.Join(mediaPath, e.ImagePath)
|
||||
}
|
||||
|
||||
default:
|
||||
filter = func(e *gtsmodel.Emoji) string {
|
||||
return path.Join(mediaPath, e.ImagePath)
|
||||
}
|
||||
}
|
||||
|
||||
// Only write if any
|
||||
// string was prepared.
|
||||
if outbuf.Len() > 0 {
|
||||
_, _ = os.Stdout.Write(outbuf.B)
|
||||
outbuf.Reset()
|
||||
emojis, err := list.GetAllEmojisPaths(ctx, filter)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
for _, e := range emojis {
|
||||
_, _ = list.out.WriteString(e + "\n")
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
|
|
|||
|
|
@ -20,17 +20,14 @@ package prune
|
|||
import (
|
||||
"context"
|
||||
|
||||
"code.superseriousbusiness.org/gotosocial/cmd/gotosocial/action"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/config"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/gtscontext"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/log"
|
||||
"github.com/superseriousbusiness/gotosocial/cmd/gotosocial/action"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/config"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/gtscontext"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/log"
|
||||
)
|
||||
|
||||
// check function conformance.
|
||||
var _ action.GTSAction = All
|
||||
|
||||
// All performs all media clean actions
|
||||
func All(ctx context.Context) error {
|
||||
var All action.GTSAction = func(ctx context.Context) error {
|
||||
// Setup pruning utilities.
|
||||
prune, err := setupPrune(ctx)
|
||||
if err != nil {
|
||||
|
|
|
|||
|
|
@ -21,13 +21,13 @@ import (
|
|||
"context"
|
||||
"fmt"
|
||||
|
||||
"code.superseriousbusiness.org/gotosocial/internal/cleaner"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/db"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/db/bundb"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/gtserror"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/media"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/state"
|
||||
gtsstorage "code.superseriousbusiness.org/gotosocial/internal/storage"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/cleaner"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/db"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/db/bundb"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/gtserror"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/media"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/state"
|
||||
gtsstorage "github.com/superseriousbusiness/gotosocial/internal/storage"
|
||||
)
|
||||
|
||||
type prune struct {
|
||||
|
|
@ -42,17 +42,13 @@ func setupPrune(ctx context.Context) (*prune, error) {
|
|||
var state state.State
|
||||
|
||||
state.Caches.Init()
|
||||
if err := state.Caches.Start(); err != nil {
|
||||
return nil, fmt.Errorf("error starting caches: %w", err)
|
||||
}
|
||||
state.Caches.Start()
|
||||
|
||||
// Scheduler is required for the
|
||||
// cleaner, but no other workers
|
||||
// claner, but no other workers
|
||||
// are needed for this CLI action.
|
||||
state.Workers.StartScheduler()
|
||||
|
||||
// Set state DB connection.
|
||||
// Don't need Actions for this.
|
||||
dbService, err := bundb.NewBunDBService(ctx, &state)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("error creating dbservice: %w", err)
|
||||
|
|
|
|||
|
|
@ -20,17 +20,14 @@ package prune
|
|||
import (
|
||||
"context"
|
||||
|
||||
"code.superseriousbusiness.org/gotosocial/cmd/gotosocial/action"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/config"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/gtscontext"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/log"
|
||||
"github.com/superseriousbusiness/gotosocial/cmd/gotosocial/action"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/config"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/gtscontext"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/log"
|
||||
)
|
||||
|
||||
// check function conformance.
|
||||
var _ action.GTSAction = Orphaned
|
||||
|
||||
// Orphaned prunes orphaned media from storage.
|
||||
func Orphaned(ctx context.Context) error {
|
||||
var Orphaned action.GTSAction = func(ctx context.Context) error {
|
||||
// Setup pruning utilities.
|
||||
prune, err := setupPrune(ctx)
|
||||
if err != nil {
|
||||
|
|
|
|||
|
|
@ -21,17 +21,14 @@ import (
|
|||
"context"
|
||||
"time"
|
||||
|
||||
"code.superseriousbusiness.org/gotosocial/cmd/gotosocial/action"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/config"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/gtscontext"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/log"
|
||||
"github.com/superseriousbusiness/gotosocial/cmd/gotosocial/action"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/config"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/gtscontext"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/log"
|
||||
)
|
||||
|
||||
// check function conformance.
|
||||
var _ action.GTSAction = Remote
|
||||
|
||||
// Remote prunes old and/or unused remote media.
|
||||
func Remote(ctx context.Context) error {
|
||||
var Remote action.GTSAction = func(ctx context.Context) error {
|
||||
// Setup pruning utilities.
|
||||
prune, err := setupPrune(ctx)
|
||||
if err != nil {
|
||||
|
|
|
|||
|
|
@ -22,26 +22,23 @@ import (
|
|||
"errors"
|
||||
"fmt"
|
||||
|
||||
"code.superseriousbusiness.org/gotosocial/cmd/gotosocial/action"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/config"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/db/bundb"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/state"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/trans"
|
||||
"github.com/superseriousbusiness/gotosocial/cmd/gotosocial/action"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/config"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/db/bundb"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/state"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/trans"
|
||||
)
|
||||
|
||||
// check function conformance.
|
||||
var _ action.GTSAction = Export
|
||||
|
||||
// Export exports info from the database into a file
|
||||
func Export(ctx context.Context) error {
|
||||
var Export action.GTSAction = func(ctx context.Context) error {
|
||||
var state state.State
|
||||
|
||||
// Only set state DB connection.
|
||||
// Don't need Actions or Workers for this.
|
||||
dbConn, err := bundb.NewBunDBService(ctx, &state)
|
||||
if err != nil {
|
||||
return fmt.Errorf("error creating dbservice: %s", err)
|
||||
}
|
||||
|
||||
// Set the state DB connection
|
||||
state.DB = dbConn
|
||||
|
||||
exporter := trans.NewExporter(dbConn)
|
||||
|
|
|
|||
|
|
@ -22,26 +22,23 @@ import (
|
|||
"errors"
|
||||
"fmt"
|
||||
|
||||
"code.superseriousbusiness.org/gotosocial/cmd/gotosocial/action"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/config"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/db/bundb"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/state"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/trans"
|
||||
"github.com/superseriousbusiness/gotosocial/cmd/gotosocial/action"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/config"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/db/bundb"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/state"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/trans"
|
||||
)
|
||||
|
||||
// check function conformance.
|
||||
var _ action.GTSAction = Import
|
||||
|
||||
// Import imports info from a file into the database
|
||||
func Import(ctx context.Context) error {
|
||||
var Import action.GTSAction = func(ctx context.Context) error {
|
||||
var state state.State
|
||||
|
||||
// Only set state DB connection.
|
||||
// Don't need Actions or Workers for this.
|
||||
dbConn, err := bundb.NewBunDBService(ctx, &state)
|
||||
if err != nil {
|
||||
return fmt.Errorf("error creating dbservice: %s", err)
|
||||
}
|
||||
|
||||
// Set the state DB connection
|
||||
state.DB = dbConn
|
||||
|
||||
importer := trans.NewImporter(dbConn)
|
||||
|
|
|
|||
|
|
@ -22,21 +22,21 @@ import (
|
|||
"encoding/json"
|
||||
"os"
|
||||
|
||||
"code.superseriousbusiness.org/gotosocial/cmd/gotosocial/action"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/config"
|
||||
"github.com/superseriousbusiness/gotosocial/cmd/gotosocial/action"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/config"
|
||||
)
|
||||
|
||||
// check function conformance.
|
||||
var _ action.GTSAction = Config
|
||||
|
||||
// Config just prints the collated config out to stdout as json.
|
||||
func Config(ctx context.Context) (err error) {
|
||||
var Config action.GTSAction = func(ctx context.Context) (err error) {
|
||||
var raw map[string]interface{}
|
||||
|
||||
// Marshal configuration to a raw JSON map
|
||||
config.Config(func(cfg *config.Configuration) {
|
||||
raw = cfg.MarshalMap()
|
||||
raw, err = cfg.MarshalMap()
|
||||
})
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
enc := json.NewEncoder(os.Stdout)
|
||||
enc.SetIndent("", " ")
|
||||
|
|
|
|||
|
|
@ -1,68 +0,0 @@
|
|||
// 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/>.
|
||||
|
||||
package migration
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
|
||||
"code.superseriousbusiness.org/gotosocial/cmd/gotosocial/action"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/db/bundb"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/log"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/state"
|
||||
)
|
||||
|
||||
// check function conformance.
|
||||
var _ action.GTSAction = Run
|
||||
|
||||
// Run will initialize the database, running any available migrations.
|
||||
func Run(ctx context.Context) error {
|
||||
var state state.State
|
||||
|
||||
defer func() {
|
||||
if state.DB != nil {
|
||||
// Lastly, if database service was started,
|
||||
// ensure it gets closed now all else stopped.
|
||||
if err := state.DB.Close(); err != nil {
|
||||
log.Errorf(ctx, "error stopping database: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
// Finally reached end of shutdown.
|
||||
log.Info(ctx, "done! exiting...")
|
||||
}()
|
||||
|
||||
// Initialize caches
|
||||
state.Caches.Init()
|
||||
if err := state.Caches.Start(); err != nil {
|
||||
return fmt.Errorf("error starting caches: %w", err)
|
||||
}
|
||||
|
||||
log.Info(ctx, "starting db service...")
|
||||
|
||||
// Open connection to the database now caches started.
|
||||
dbService, err := bundb.NewBunDBService(ctx, &state)
|
||||
if err != nil {
|
||||
return fmt.Errorf("error creating dbservice: %s", err)
|
||||
}
|
||||
|
||||
// Set DB on state.
|
||||
state.DB = dbService
|
||||
|
||||
return nil
|
||||
}
|
||||
|
|
@ -22,7 +22,6 @@ import (
|
|||
"errors"
|
||||
"fmt"
|
||||
"net/http"
|
||||
"net/netip"
|
||||
"os"
|
||||
"os/signal"
|
||||
"runtime"
|
||||
|
|
@ -30,82 +29,46 @@ import (
|
|||
"syscall"
|
||||
"time"
|
||||
|
||||
"code.superseriousbusiness.org/gotosocial/cmd/gotosocial/action"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/admin"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/api"
|
||||
apiutil "code.superseriousbusiness.org/gotosocial/internal/api/util"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/cleaner"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/config"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/db/bundb"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/email"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/federation"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/federation/federatingdb"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/filter/interaction"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/filter/mutes"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/filter/spam"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/filter/status"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/filter/visibility"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/gtserror"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/httpclient"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/log"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/media"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/media/ffmpeg"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/messages"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/middleware"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/oauth"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/oauth/handlers"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/observability"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/oidc"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/processing"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/router"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/state"
|
||||
gtsstorage "code.superseriousbusiness.org/gotosocial/internal/storage"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/subscriptions"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/transport"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/typeutils"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/web"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/webpush"
|
||||
"github.com/KimMachineGun/automemlimit/memlimit"
|
||||
"github.com/gin-gonic/gin"
|
||||
"github.com/superseriousbusiness/gotosocial/cmd/gotosocial/action"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/api"
|
||||
apiutil "github.com/superseriousbusiness/gotosocial/internal/api/util"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/cleaner"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/filter/interaction"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/filter/spam"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/filter/visibility"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/gtserror"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/media/ffmpeg"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/messages"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/metrics"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/middleware"
|
||||
tlprocessor "github.com/superseriousbusiness/gotosocial/internal/processing/timeline"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/timeline"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/tracing"
|
||||
"go.uber.org/automaxprocs/maxprocs"
|
||||
|
||||
"github.com/superseriousbusiness/gotosocial/internal/config"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/db/bundb"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/email"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/federation"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/federation/federatingdb"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/httpclient"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/log"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/media"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/oauth"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/oidc"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/processing"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/router"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/state"
|
||||
gtsstorage "github.com/superseriousbusiness/gotosocial/internal/storage"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/transport"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/typeutils"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/web"
|
||||
)
|
||||
|
||||
// check function conformance.
|
||||
var _ action.GTSAction = Maintenance
|
||||
var _ action.GTSAction = Start
|
||||
|
||||
// Maintenance starts and creates a GoToSocial server
|
||||
// in maintenance mode (returns 503 for most requests).
|
||||
func Maintenance(ctx context.Context) error {
|
||||
route, err := router.New(ctx)
|
||||
if err != nil {
|
||||
return fmt.Errorf("error creating maintenance router: %w", err)
|
||||
}
|
||||
|
||||
// Route maintenance handlers.
|
||||
maintenance := web.NewMaintenance()
|
||||
maintenance.Route(route)
|
||||
|
||||
// Start the maintenance router.
|
||||
if err := route.Start(); err != nil {
|
||||
return fmt.Errorf("error starting maintenance router: %w", err)
|
||||
}
|
||||
|
||||
// Catch shutdown signals from the OS.
|
||||
sigs := make(chan os.Signal, 1)
|
||||
signal.Notify(sigs, syscall.SIGINT, syscall.SIGTERM)
|
||||
sig := <-sigs // block until signal received
|
||||
log.Infof(ctx, "received signal %s, shutting down", sig)
|
||||
|
||||
if err := route.Stop(); err != nil {
|
||||
log.Errorf(ctx, "error stopping router: %v", err)
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// Start creates and starts a gotosocial server
|
||||
func Start(ctx context.Context) error {
|
||||
var Start action.GTSAction = func(ctx context.Context) error {
|
||||
// Set GOMAXPROCS / GOMEMLIMIT
|
||||
// to match container limits.
|
||||
setLimits(ctx)
|
||||
|
|
@ -122,9 +85,8 @@ func Start(ctx context.Context) error {
|
|||
)
|
||||
|
||||
defer func() {
|
||||
// Stop any started caches.
|
||||
//
|
||||
// Noop if never started.
|
||||
// Stop caches with
|
||||
// background tasks.
|
||||
state.Caches.Stop()
|
||||
|
||||
if route != nil {
|
||||
|
|
@ -139,10 +101,22 @@ func Start(ctx context.Context) error {
|
|||
// Stop any currently running
|
||||
// worker processes / scheduled
|
||||
// tasks from being executed.
|
||||
//
|
||||
// Noop on unstarted workers.
|
||||
state.Workers.Stop()
|
||||
|
||||
if state.Timelines.Home != nil {
|
||||
// Home timeline mgr was setup, ensure it gets stopped.
|
||||
if err := state.Timelines.Home.Stop(); err != nil {
|
||||
log.Errorf(ctx, "error stopping home timeline: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
if state.Timelines.List != nil {
|
||||
// List timeline mgr was setup, ensure it gets stopped.
|
||||
if err := state.Timelines.List.Stop(); err != nil {
|
||||
log.Errorf(ctx, "error stopping list timeline: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
if process != nil {
|
||||
const timeout = time.Minute
|
||||
|
||||
|
|
@ -172,33 +146,14 @@ func Start(ctx context.Context) error {
|
|||
log.Info(ctx, "done! exiting...")
|
||||
}()
|
||||
|
||||
// Create maintenance router.
|
||||
var err error
|
||||
route, err = router.New(ctx)
|
||||
if err != nil {
|
||||
return fmt.Errorf("error creating maintenance router: %w", err)
|
||||
}
|
||||
|
||||
// Route maintenance handlers.
|
||||
maintenance := web.NewMaintenance()
|
||||
maintenance.Route(route)
|
||||
|
||||
// Start the maintenance router to handle reqs
|
||||
// while the instance is starting up / migrating.
|
||||
if err := route.Start(); err != nil {
|
||||
return fmt.Errorf("error starting maintenance router: %w", err)
|
||||
}
|
||||
|
||||
// Initialize tracing (noop if not enabled).
|
||||
if err := observability.InitializeTracing(ctx); err != nil {
|
||||
if err := tracing.Initialize(); err != nil {
|
||||
return fmt.Errorf("error initializing tracing: %w", err)
|
||||
}
|
||||
|
||||
// Initialize caches
|
||||
state.Caches.Init()
|
||||
if err := state.Caches.Start(); err != nil {
|
||||
return fmt.Errorf("error starting caches: %w", err)
|
||||
}
|
||||
state.Caches.Start()
|
||||
|
||||
// Open connection to the database now caches started.
|
||||
dbService, err := bundb.NewBunDBService(ctx, state)
|
||||
|
|
@ -209,10 +164,6 @@ func Start(ctx context.Context) error {
|
|||
// Set DB on state.
|
||||
state.DB = dbService
|
||||
|
||||
// Set Actions on state, providing workers to
|
||||
// Actions as well for triggering side effects.
|
||||
state.AdminActions = admin.New(dbService, &state.Workers)
|
||||
|
||||
// Ensure necessary database instance prerequisites exist.
|
||||
if err := dbService.CreateInstanceAccount(ctx); err != nil {
|
||||
return fmt.Errorf("error creating instance account: %s", err)
|
||||
|
|
@ -236,17 +187,10 @@ func Start(ctx context.Context) error {
|
|||
return fmt.Errorf("error opening storage backend: %w", err)
|
||||
}
|
||||
|
||||
// Parse http client allow
|
||||
// and block range exceptions.
|
||||
ranges, err := parseClientRanges()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
// Prepare wrapped httpclient with config.
|
||||
client := httpclient.New(httpclient.Config{
|
||||
AllowRanges: ranges.allow,
|
||||
BlockRanges: ranges.block,
|
||||
AllowRanges: config.MustParseIPPrefixes(config.GetHTTPClientAllowIPs()),
|
||||
BlockRanges: config.MustParseIPPrefixes(config.GetHTTPClientBlockIPs()),
|
||||
Timeout: config.GetHTTPClientTimeout(),
|
||||
TLSInsecureSkipVerify: config.GetHTTPClientTLSInsecureSkipVerify(),
|
||||
})
|
||||
|
|
@ -264,22 +208,13 @@ func Start(ctx context.Context) error {
|
|||
|
||||
// Build handlers used in later initializations.
|
||||
mediaManager := media.NewManager(state)
|
||||
oauthServer := oauth.New(ctx, state,
|
||||
handlers.GetValidateURIHandler(ctx),
|
||||
handlers.GetClientScopeHandler(ctx, state),
|
||||
handlers.GetAuthorizeScopeHandler(),
|
||||
handlers.GetInternalErrorHandler(ctx),
|
||||
handlers.GetResponseErrorHandler(ctx),
|
||||
handlers.GetUserAuthorizationHandler(),
|
||||
)
|
||||
oauthServer := oauth.New(ctx, dbService)
|
||||
typeConverter := typeutils.NewConverter(state)
|
||||
visFilter := visibility.NewFilter(state)
|
||||
muteFilter := mutes.NewFilter(state)
|
||||
intFilter := interaction.NewFilter(state)
|
||||
statusFilter := status.NewFilter(state)
|
||||
spamFilter := spam.NewFilter(state)
|
||||
federatingDB := federatingdb.New(state, typeConverter, visFilter, intFilter, spamFilter)
|
||||
transportController := transport.NewController(state, federatingDB, client)
|
||||
transportController := transport.NewController(state, federatingDB, &federation.Clock{}, client)
|
||||
federator := federation.NewFederator(
|
||||
state,
|
||||
federatingDB,
|
||||
|
|
@ -307,13 +242,25 @@ func Start(ctx context.Context) error {
|
|||
}
|
||||
}
|
||||
|
||||
// Get or create a VAPID key pair.
|
||||
if _, err := dbService.GetVAPIDKeyPair(ctx); err != nil {
|
||||
return gtserror.Newf("error getting or creating VAPID key pair: %w", err)
|
||||
// Initialize both home / list timelines.
|
||||
state.Timelines.Home = timeline.NewManager(
|
||||
tlprocessor.HomeTimelineGrab(state),
|
||||
tlprocessor.HomeTimelineFilter(state, visFilter),
|
||||
tlprocessor.HomeTimelineStatusPrepare(state, typeConverter),
|
||||
tlprocessor.SkipInsert(),
|
||||
)
|
||||
if err := state.Timelines.Home.Start(); err != nil {
|
||||
return fmt.Errorf("error starting home timeline: %s", err)
|
||||
}
|
||||
state.Timelines.List = timeline.NewManager(
|
||||
tlprocessor.ListTimelineGrab(state),
|
||||
tlprocessor.ListTimelineFilter(state, visFilter),
|
||||
tlprocessor.ListTimelineStatusPrepare(state, typeConverter),
|
||||
tlprocessor.SkipInsert(),
|
||||
)
|
||||
if err := state.Timelines.List.Start(); err != nil {
|
||||
return fmt.Errorf("error starting list timeline: %s", err)
|
||||
}
|
||||
|
||||
// Create a Web Push notification sender.
|
||||
webPushSender := webpush.NewSender(client, state, typeConverter)
|
||||
|
||||
// Start the job scheduler
|
||||
// (this is required for cleaner).
|
||||
|
|
@ -336,41 +283,25 @@ func Start(ctx context.Context) error {
|
|||
// Create background cleaner.
|
||||
cleaner := cleaner.New(state)
|
||||
|
||||
// Create subscriptions fetcher.
|
||||
subscriptions := subscriptions.New(
|
||||
state,
|
||||
transportController,
|
||||
typeConverter,
|
||||
)
|
||||
// Now schedule background cleaning tasks.
|
||||
if err := cleaner.ScheduleJobs(); err != nil {
|
||||
return fmt.Errorf("error scheduling cleaner jobs: %w", err)
|
||||
}
|
||||
|
||||
// Create the processor using all the
|
||||
// other services we've created so far.
|
||||
process = processing.NewProcessor(
|
||||
cleaner,
|
||||
subscriptions,
|
||||
typeConverter,
|
||||
federator,
|
||||
oauthServer,
|
||||
mediaManager,
|
||||
state,
|
||||
emailSender,
|
||||
webPushSender,
|
||||
visFilter,
|
||||
muteFilter,
|
||||
intFilter,
|
||||
statusFilter,
|
||||
)
|
||||
|
||||
// Schedule background cleaning tasks.
|
||||
if err := cleaner.ScheduleJobs(); err != nil {
|
||||
return fmt.Errorf("error scheduling cleaner jobs: %w", err)
|
||||
}
|
||||
|
||||
// Schedule background subscriptions updating.
|
||||
if err := subscriptions.ScheduleJobs(); err != nil {
|
||||
return fmt.Errorf("error scheduling subscriptions jobs: %w", err)
|
||||
}
|
||||
|
||||
// Initialize the specialized workers pools.
|
||||
state.Workers.Client.Init(messages.ClientMsgIndices())
|
||||
state.Workers.Federator.Init(messages.FederatorMsgIndices())
|
||||
|
|
@ -386,13 +317,8 @@ func Start(ctx context.Context) error {
|
|||
return fmt.Errorf("error scheduling poll expiries: %w", err)
|
||||
}
|
||||
|
||||
// schedule publication tasks for all scheduled statuses.
|
||||
if err := process.Status().ScheduledStatusesScheduleAll(ctx); err != nil {
|
||||
return fmt.Errorf("error scheduling status publications: %w", err)
|
||||
}
|
||||
|
||||
// Initialize metrics.
|
||||
if err := observability.InitializeMetrics(ctx, state); err != nil {
|
||||
if err := metrics.Initialize(state.DB); err != nil {
|
||||
return fmt.Errorf("error initializing metrics: %w", err)
|
||||
}
|
||||
|
||||
|
|
@ -405,19 +331,12 @@ func Start(ctx context.Context) error {
|
|||
HTTP router initialization
|
||||
*/
|
||||
|
||||
// Close down the maintenance router.
|
||||
if err := route.Stop(); err != nil {
|
||||
return fmt.Errorf("error stopping maintenance router: %w", err)
|
||||
}
|
||||
|
||||
// Instantiate the main router.
|
||||
route, err = router.New(ctx)
|
||||
if err != nil {
|
||||
return fmt.Errorf("error creating main router: %s", err)
|
||||
return fmt.Errorf("error creating router: %s", err)
|
||||
}
|
||||
|
||||
// Start preparing global middleware
|
||||
// stack (used for every request).
|
||||
// Start preparing middleware stack.
|
||||
middlewares := make([]gin.HandlerFunc, 1)
|
||||
|
||||
// RequestID middleware must run before tracing!
|
||||
|
|
@ -425,12 +344,12 @@ func Start(ctx context.Context) error {
|
|||
|
||||
// Add tracing middleware if enabled.
|
||||
if config.GetTracingEnabled() {
|
||||
middlewares = append(middlewares, observability.TracingMiddleware())
|
||||
middlewares = append(middlewares, tracing.InstrumentGin())
|
||||
}
|
||||
|
||||
// Add metrics middleware if enabled.
|
||||
if config.GetMetricsEnabled() {
|
||||
middlewares = append(middlewares, observability.MetricsMiddleware())
|
||||
middlewares = append(middlewares, metrics.InstrumentGin())
|
||||
}
|
||||
|
||||
middlewares = append(middlewares, []gin.HandlerFunc{
|
||||
|
|
@ -493,54 +412,36 @@ func Start(ctx context.Context) error {
|
|||
return fmt.Errorf("error generating session name for session middleware: %w", err)
|
||||
}
|
||||
|
||||
// Configure our instance cookie policy.
|
||||
cookiePolicy := apiutil.NewCookiePolicy()
|
||||
|
||||
var (
|
||||
authModule = api.NewAuth(state, process, idp, routerSession, sessionName, cookiePolicy) // auth/oauth paths
|
||||
clientModule = api.NewClient(state, process) // api client endpoints
|
||||
healthModule = api.NewHealth(dbService.Ready) // Health check endpoints
|
||||
fileserverModule = api.NewFileserver(process) // fileserver endpoints
|
||||
robotsModule = api.NewRobots() // robots.txt endpoint
|
||||
wellKnownModule = api.NewWellKnown(process) // .well-known endpoints
|
||||
nodeInfoModule = api.NewNodeInfo(process) // nodeinfo endpoint
|
||||
activityPubModule = api.NewActivityPub(dbService, process) // ActivityPub endpoints
|
||||
webModule = web.New(dbService, process, cookiePolicy) // web pages + user profiles + settings panels etc
|
||||
authModule = api.NewAuth(dbService, process, idp, routerSession, sessionName) // auth/oauth paths
|
||||
clientModule = api.NewClient(state, process) // api client endpoints
|
||||
metricsModule = api.NewMetrics() // Metrics endpoints
|
||||
healthModule = api.NewHealth(dbService.Ready) // Health check endpoints
|
||||
fileserverModule = api.NewFileserver(process) // fileserver endpoints
|
||||
wellKnownModule = api.NewWellKnown(process) // .well-known endpoints
|
||||
nodeInfoModule = api.NewNodeInfo(process) // nodeinfo endpoint
|
||||
activityPubModule = api.NewActivityPub(dbService, process) // ActivityPub endpoints
|
||||
webModule = web.New(dbService, process) // web pages + user profiles + settings panels etc
|
||||
)
|
||||
|
||||
// Create per-route / per-grouping middlewares.
|
||||
// create required middleware
|
||||
// rate limiting
|
||||
rlLimit := config.GetAdvancedRateLimitRequests()
|
||||
exceptions := config.GetAdvancedRateLimitExceptions()
|
||||
clLimit := middleware.RateLimit(rlLimit, exceptions) // client api
|
||||
s2sLimit := middleware.RateLimit(rlLimit, exceptions) // server-to-server (AP)
|
||||
fsMainLimit := middleware.RateLimit(rlLimit, exceptions) // fileserver / web templates
|
||||
fsEmojiLimit := middleware.RateLimit(rlLimit*2, exceptions) // fileserver (emojis only, use high limit)
|
||||
rlExceptions := config.GetAdvancedRateLimitExceptions()
|
||||
clLimit := middleware.RateLimit(rlLimit, rlExceptions) // client api
|
||||
s2sLimit := middleware.RateLimit(rlLimit, rlExceptions) // server-to-server (AP)
|
||||
fsMainLimit := middleware.RateLimit(rlLimit, rlExceptions) // fileserver / web templates
|
||||
fsEmojiLimit := middleware.RateLimit(rlLimit*2, rlExceptions) // fileserver (emojis only, use high limit)
|
||||
|
||||
// throttling
|
||||
cpuMultiplier := config.GetAdvancedThrottlingMultiplier()
|
||||
retryAfter := config.GetAdvancedThrottlingRetryAfter()
|
||||
clThrottle := middleware.Throttle(cpuMultiplier, retryAfter) // client api
|
||||
s2sThrottle := middleware.Throttle(cpuMultiplier, retryAfter)
|
||||
|
||||
// server-to-server (AP)
|
||||
fsThrottle := middleware.Throttle(cpuMultiplier, retryAfter) // fileserver / web templates / emojis
|
||||
pkThrottle := middleware.Throttle(cpuMultiplier, retryAfter) // throttle public key endpoint separately
|
||||
|
||||
// Robots http headers (x-robots-tag).
|
||||
//
|
||||
// robotsDisallowAll is used for client API + S2S endpoints
|
||||
// that definitely should never be indexed by crawlers.
|
||||
//
|
||||
// robotsDisallowAIOnly is used for utility endpoints,
|
||||
// fileserver, and for web endpoints that set their own
|
||||
// additional robots directives in HTML meta tags.
|
||||
//
|
||||
// Other endpoints like .well-known and nodeinfo handle
|
||||
// robots headers themselves based on configuration.
|
||||
robotsDisallowAll := middleware.RobotsHeaders("")
|
||||
robotsDisallowAIOnly := middleware.RobotsHeaders("aiOnly")
|
||||
|
||||
// Gzip middleware is applied to all endpoints except
|
||||
// fileserver (compression too expensive for those),
|
||||
// health (which really doesn't need compression), and
|
||||
|
|
@ -550,17 +451,17 @@ func Start(ctx context.Context) error {
|
|||
|
||||
// these should be routed in order;
|
||||
// apply throttling *after* rate limiting
|
||||
authModule.Route(route, clLimit, clThrottle, robotsDisallowAll, gzip)
|
||||
clientModule.Route(route, clLimit, clThrottle, robotsDisallowAll, gzip)
|
||||
healthModule.Route(route, clLimit, clThrottle, robotsDisallowAIOnly)
|
||||
fileserverModule.Route(route, fsMainLimit, fsThrottle, robotsDisallowAIOnly)
|
||||
fileserverModule.RouteEmojis(route, instanceAccount.ID, fsEmojiLimit, fsThrottle, robotsDisallowAIOnly)
|
||||
robotsModule.Route(route, fsMainLimit, fsThrottle, robotsDisallowAIOnly, gzip)
|
||||
authModule.Route(route, clLimit, clThrottle, gzip)
|
||||
clientModule.Route(route, clLimit, clThrottle, gzip)
|
||||
metricsModule.Route(route, clLimit, clThrottle)
|
||||
healthModule.Route(route, clLimit, clThrottle)
|
||||
fileserverModule.Route(route, fsMainLimit, fsThrottle)
|
||||
fileserverModule.RouteEmojis(route, instanceAccount.ID, fsEmojiLimit, fsThrottle)
|
||||
wellKnownModule.Route(route, gzip, s2sLimit, s2sThrottle)
|
||||
nodeInfoModule.Route(route, s2sLimit, s2sThrottle, gzip)
|
||||
activityPubModule.Route(route, s2sLimit, s2sThrottle, robotsDisallowAll, gzip)
|
||||
activityPubModule.RoutePublicKey(route, s2sLimit, pkThrottle, robotsDisallowAll, gzip)
|
||||
webModule.Route(route, fsMainLimit, fsThrottle, robotsDisallowAIOnly, gzip)
|
||||
activityPubModule.Route(route, s2sLimit, s2sThrottle, gzip)
|
||||
activityPubModule.RoutePublicKey(route, s2sLimit, pkThrottle, gzip)
|
||||
webModule.Route(route, fsMainLimit, fsThrottle, gzip)
|
||||
|
||||
// Finally start the main http server!
|
||||
if err := route.Start(); err != nil {
|
||||
|
|
@ -611,44 +512,3 @@ func compileWASM(ctx context.Context) error {
|
|||
|
||||
return nil
|
||||
}
|
||||
|
||||
func parseClientRanges() (
|
||||
*struct {
|
||||
allow []netip.Prefix
|
||||
block []netip.Prefix
|
||||
},
|
||||
error,
|
||||
) {
|
||||
parseF := func(ips []string, ranges []netip.Prefix, flag string) error {
|
||||
for i, ip := range ips {
|
||||
p, err := netip.ParsePrefix(ip)
|
||||
if err != nil {
|
||||
return fmt.Errorf("error parsing %s value %s: %w", flag, ip, err)
|
||||
}
|
||||
ranges[i] = p
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
allowIPs := config.GetHTTPClientAllowIPs()
|
||||
allowRanges := make([]netip.Prefix, len(allowIPs))
|
||||
allowFlag := config.HTTPClientAllowIPsFlag
|
||||
if err := parseF(allowIPs, allowRanges, allowFlag); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
blockIPs := config.GetHTTPClientBlockIPs()
|
||||
blockRanges := make([]netip.Prefix, len(blockIPs))
|
||||
blockFlag := config.HTTPClientBlockIPsFlag
|
||||
if err := parseF(blockIPs, blockRanges, blockFlag); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
return &struct {
|
||||
allow []netip.Prefix
|
||||
block []netip.Prefix
|
||||
}{
|
||||
allow: allowRanges,
|
||||
block: blockRanges,
|
||||
}, nil
|
||||
}
|
||||
|
|
|
|||
|
|
@ -19,15 +19,8 @@
|
|||
|
||||
package testrig
|
||||
|
||||
import (
|
||||
"context"
|
||||
|
||||
"code.superseriousbusiness.org/gotosocial/cmd/gotosocial/action"
|
||||
)
|
||||
|
||||
// check function conformance.
|
||||
var _ action.GTSAction = Start
|
||||
import "github.com/superseriousbusiness/gotosocial/cmd/gotosocial/action"
|
||||
|
||||
// Start creates and starts a gotosocial testrig server.
|
||||
// This is only enabled in debug builds, else is nil.
|
||||
func Start(context.Context) error { return nil }
|
||||
var Start action.GTSAction
|
||||
|
|
|
|||
|
|
@ -20,42 +20,43 @@
|
|||
package testrig
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"context"
|
||||
"errors"
|
||||
"fmt"
|
||||
"io"
|
||||
"net/http"
|
||||
"os"
|
||||
"os/signal"
|
||||
"syscall"
|
||||
|
||||
"code.superseriousbusiness.org/gotosocial/cmd/gotosocial/action"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/admin"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/api"
|
||||
apiutil "code.superseriousbusiness.org/gotosocial/internal/api/util"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/cleaner"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/config"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/gtserror"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/language"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/log"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/middleware"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/observability"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/oidc"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/router"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/state"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/storage"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/subscriptions"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/typeutils"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/web"
|
||||
"code.superseriousbusiness.org/gotosocial/testrig"
|
||||
"github.com/gin-gonic/gin"
|
||||
"github.com/superseriousbusiness/gotosocial/cmd/gotosocial/action"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/api"
|
||||
apiutil "github.com/superseriousbusiness/gotosocial/internal/api/util"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/cleaner"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/config"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/filter/visibility"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/gtserror"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/language"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/log"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/metrics"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/middleware"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/oidc"
|
||||
tlprocessor "github.com/superseriousbusiness/gotosocial/internal/processing/timeline"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/router"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/state"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/storage"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/timeline"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/tracing"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/typeutils"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/web"
|
||||
"github.com/superseriousbusiness/gotosocial/testrig"
|
||||
)
|
||||
|
||||
// check function conformance.
|
||||
var _ action.GTSAction = Start
|
||||
|
||||
// Start creates and starts a gotosocial testrig server.
|
||||
// This is only enabled in debug builds, else is nil.
|
||||
func Start(ctx context.Context) error {
|
||||
var Start action.GTSAction = func(ctx context.Context) error {
|
||||
testrig.InitTestConfig()
|
||||
testrig.InitTestLog()
|
||||
|
||||
|
|
@ -89,20 +90,29 @@ func Start(ctx context.Context) error {
|
|||
// tasks from being executed.
|
||||
testrig.StopWorkers(state)
|
||||
|
||||
if state.Timelines.Home != nil {
|
||||
// Home timeline mgr was setup, ensure it gets stopped.
|
||||
if err := state.Timelines.Home.Stop(); err != nil {
|
||||
log.Errorf(ctx, "error stopping home timeline: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
if state.Timelines.List != nil {
|
||||
// List timeline mgr was setup, ensure it gets stopped.
|
||||
if err := state.Timelines.List.Stop(); err != nil {
|
||||
log.Errorf(ctx, "error stopping list timeline: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
if state.Storage != nil {
|
||||
// If storage was created, ensure torn down.
|
||||
testrig.StandardStorageTeardown(state.Storage)
|
||||
}
|
||||
|
||||
if state.DB != nil {
|
||||
// Clean up database by
|
||||
// dropping tables if required.
|
||||
if !config.GetTestrigSkipDBTeardown() {
|
||||
testrig.StandardDBTeardown(state.DB)
|
||||
}
|
||||
|
||||
// Lastly, if database service was started,
|
||||
// ensure it gets closed now all else stopped.
|
||||
testrig.StandardDBTeardown(state.DB)
|
||||
if err := state.DB.Close(); err != nil {
|
||||
log.Errorf(ctx, "error stopping database: %v", err)
|
||||
}
|
||||
|
|
@ -118,25 +128,18 @@ func Start(ctx context.Context) error {
|
|||
}
|
||||
config.SetInstanceLanguages(parsedLangs)
|
||||
|
||||
if err := observability.InitializeTracing(ctx); err != nil {
|
||||
if err := tracing.Initialize(); err != nil {
|
||||
return fmt.Errorf("error initializing tracing: %w", err)
|
||||
}
|
||||
|
||||
// Initialize caches and database
|
||||
state.DB = testrig.NewTestDB(state)
|
||||
|
||||
// Set Actions on state, providing workers to
|
||||
// Actions as well for triggering side effects.
|
||||
state.AdminActions = admin.New(state.DB, &state.Workers)
|
||||
|
||||
// New test db inits caches so we don't need to do
|
||||
// that twice, we can just start the initialized caches.
|
||||
state.Caches.Start()
|
||||
|
||||
// Populate database tables + data if required.
|
||||
if !config.GetTestrigSkipDBSetup() {
|
||||
testrig.StandardDBSetup(state.DB, nil)
|
||||
}
|
||||
testrig.StandardDBSetup(state.DB, nil)
|
||||
|
||||
// Get the instance account (we'll need this later).
|
||||
instanceAccount, err := state.DB.GetInstanceAccount(ctx, "")
|
||||
|
|
@ -156,23 +159,51 @@ func Start(ctx context.Context) error {
|
|||
testrig.StandardStorageSetup(state.Storage, "./testrig/media")
|
||||
|
||||
// build backend handlers
|
||||
httpClient := testrig.NewMockHTTPClient(nil, "./testrig/media")
|
||||
transportController := testrig.NewTestTransportController(state, httpClient)
|
||||
transportController := testrig.NewTestTransportController(state, testrig.NewMockHTTPClient(func(req *http.Request) (*http.Response, error) {
|
||||
r := io.NopCloser(bytes.NewReader([]byte{}))
|
||||
return &http.Response{
|
||||
StatusCode: 200,
|
||||
Body: r,
|
||||
Header: http.Header{
|
||||
"Content-Type": req.Header.Values("Accept"),
|
||||
},
|
||||
}, nil
|
||||
}, ""))
|
||||
mediaManager := testrig.NewTestMediaManager(state)
|
||||
federator := testrig.NewTestFederator(state, transportController, mediaManager)
|
||||
|
||||
emailSender := testrig.NewEmailSender("./web/template/", nil)
|
||||
webPushSender := testrig.NewWebPushMockSender()
|
||||
typeConverter := typeutils.NewConverter(state)
|
||||
filter := visibility.NewFilter(state)
|
||||
|
||||
processor := testrig.NewTestProcessor(state, federator, emailSender, webPushSender, mediaManager)
|
||||
// Initialize both home / list timelines.
|
||||
state.Timelines.Home = timeline.NewManager(
|
||||
tlprocessor.HomeTimelineGrab(state),
|
||||
tlprocessor.HomeTimelineFilter(state, filter),
|
||||
tlprocessor.HomeTimelineStatusPrepare(state, typeConverter),
|
||||
tlprocessor.SkipInsert(),
|
||||
)
|
||||
if err := state.Timelines.Home.Start(); err != nil {
|
||||
return fmt.Errorf("error starting home timeline: %s", err)
|
||||
}
|
||||
state.Timelines.List = timeline.NewManager(
|
||||
tlprocessor.ListTimelineGrab(state),
|
||||
tlprocessor.ListTimelineFilter(state, filter),
|
||||
tlprocessor.ListTimelineStatusPrepare(state, typeConverter),
|
||||
tlprocessor.SkipInsert(),
|
||||
)
|
||||
if err := state.Timelines.List.Start(); err != nil {
|
||||
return fmt.Errorf("error starting list timeline: %s", err)
|
||||
}
|
||||
|
||||
processor := testrig.NewTestProcessor(state, federator, emailSender, mediaManager)
|
||||
|
||||
// Initialize workers.
|
||||
testrig.StartWorkers(state, processor.Workers())
|
||||
defer testrig.StopWorkers(state)
|
||||
|
||||
// Initialize metrics.
|
||||
if err := observability.InitializeMetrics(ctx, state); err != nil {
|
||||
if err := metrics.Initialize(state.DB); err != nil {
|
||||
return fmt.Errorf("error initializing metrics: %w", err)
|
||||
}
|
||||
|
||||
|
|
@ -190,11 +221,11 @@ func Start(ctx context.Context) error {
|
|||
middleware.AddRequestID(config.GetRequestIDHeader()), // requestID middleware must run before tracing
|
||||
}
|
||||
if config.GetTracingEnabled() {
|
||||
middlewares = append(middlewares, observability.TracingMiddleware())
|
||||
middlewares = append(middlewares, tracing.InstrumentGin())
|
||||
}
|
||||
|
||||
if config.GetMetricsEnabled() {
|
||||
middlewares = append(middlewares, observability.MetricsMiddleware())
|
||||
middlewares = append(middlewares, metrics.InstrumentGin())
|
||||
}
|
||||
|
||||
middlewares = append(middlewares, []gin.HandlerFunc{
|
||||
|
|
@ -255,28 +286,25 @@ func Start(ctx context.Context) error {
|
|||
return fmt.Errorf("error generating session name for session middleware: %w", err)
|
||||
}
|
||||
|
||||
// Configure our instance cookie policy.
|
||||
cookiePolicy := apiutil.NewCookiePolicy()
|
||||
|
||||
var (
|
||||
authModule = api.NewAuth(state, processor, idp, routerSession, sessionName, cookiePolicy) // auth/oauth paths
|
||||
clientModule = api.NewClient(state, processor) // api client endpoints
|
||||
healthModule = api.NewHealth(state.DB.Ready) // Health check endpoints
|
||||
fileserverModule = api.NewFileserver(processor) // fileserver endpoints
|
||||
robotsModule = api.NewRobots() // robots.txt endpoint
|
||||
wellKnownModule = api.NewWellKnown(processor) // .well-known endpoints
|
||||
nodeInfoModule = api.NewNodeInfo(processor) // nodeinfo endpoint
|
||||
activityPubModule = api.NewActivityPub(state.DB, processor) // ActivityPub endpoints
|
||||
webModule = web.New(state.DB, processor, cookiePolicy) // web pages + user profiles + settings panels etc
|
||||
authModule = api.NewAuth(state.DB, processor, idp, routerSession, sessionName) // auth/oauth paths
|
||||
clientModule = api.NewClient(state, processor) // api client endpoints
|
||||
metricsModule = api.NewMetrics() // Metrics endpoints
|
||||
healthModule = api.NewHealth(state.DB.Ready) // Health check endpoints
|
||||
fileserverModule = api.NewFileserver(processor) // fileserver endpoints
|
||||
wellKnownModule = api.NewWellKnown(processor) // .well-known endpoints
|
||||
nodeInfoModule = api.NewNodeInfo(processor) // nodeinfo endpoint
|
||||
activityPubModule = api.NewActivityPub(state.DB, processor) // ActivityPub endpoints
|
||||
webModule = web.New(state.DB, processor) // web pages + user profiles + settings panels etc
|
||||
)
|
||||
|
||||
// these should be routed in order
|
||||
authModule.Route(route)
|
||||
clientModule.Route(route)
|
||||
metricsModule.Route(route)
|
||||
healthModule.Route(route)
|
||||
fileserverModule.Route(route)
|
||||
fileserverModule.RouteEmojis(route, instanceAccount.ID)
|
||||
robotsModule.Route(route)
|
||||
wellKnownModule.Route(route)
|
||||
nodeInfoModule.Route(route)
|
||||
activityPubModule.Route(route)
|
||||
|
|
@ -286,23 +314,11 @@ func Start(ctx context.Context) error {
|
|||
// Create background cleaner.
|
||||
cleaner := cleaner.New(state)
|
||||
|
||||
// Schedule background cleaning tasks.
|
||||
// Now schedule background cleaning tasks.
|
||||
if err := cleaner.ScheduleJobs(); err != nil {
|
||||
return fmt.Errorf("error scheduling cleaner jobs: %w", err)
|
||||
}
|
||||
|
||||
// Create subscriptions fetcher.
|
||||
subscriptions := subscriptions.New(
|
||||
state,
|
||||
transportController,
|
||||
typeConverter,
|
||||
)
|
||||
|
||||
// Schedule background subscriptions updating.
|
||||
if err := subscriptions.ScheduleJobs(); err != nil {
|
||||
return fmt.Errorf("error scheduling subscriptions jobs: %w", err)
|
||||
}
|
||||
|
||||
// Finally start the main http server!
|
||||
if err := route.Start(); err != nil {
|
||||
return fmt.Errorf("error starting router: %w", err)
|
||||
|
|
|
|||
|
|
@ -18,12 +18,12 @@
|
|||
package main
|
||||
|
||||
import (
|
||||
"code.superseriousbusiness.org/gotosocial/cmd/gotosocial/action/admin/account"
|
||||
"code.superseriousbusiness.org/gotosocial/cmd/gotosocial/action/admin/media"
|
||||
"code.superseriousbusiness.org/gotosocial/cmd/gotosocial/action/admin/media/prune"
|
||||
"code.superseriousbusiness.org/gotosocial/cmd/gotosocial/action/admin/trans"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/config"
|
||||
"github.com/spf13/cobra"
|
||||
"github.com/superseriousbusiness/gotosocial/cmd/gotosocial/action/admin/account"
|
||||
"github.com/superseriousbusiness/gotosocial/cmd/gotosocial/action/admin/media"
|
||||
"github.com/superseriousbusiness/gotosocial/cmd/gotosocial/action/admin/media/prune"
|
||||
"github.com/superseriousbusiness/gotosocial/cmd/gotosocial/action/admin/trans"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/config"
|
||||
)
|
||||
|
||||
func adminCommands() *cobra.Command {
|
||||
|
|
@ -146,19 +146,6 @@ func adminCommands() *cobra.Command {
|
|||
config.AddAdminAccountPassword(adminAccountPasswordCmd)
|
||||
adminAccountCmd.AddCommand(adminAccountPasswordCmd)
|
||||
|
||||
adminAccountDisable2FACmd := &cobra.Command{
|
||||
Use: "disable-2fa",
|
||||
Short: "disable 2fa for the given local account",
|
||||
PreRunE: func(cmd *cobra.Command, args []string) error {
|
||||
return preRun(preRunArgs{cmd: cmd})
|
||||
},
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
return run(cmd.Context(), account.Disable2FA)
|
||||
},
|
||||
}
|
||||
config.AddAdminAccount(adminAccountDisable2FACmd)
|
||||
adminAccountCmd.AddCommand(adminAccountDisable2FACmd)
|
||||
|
||||
adminCmd.AddCommand(adminAccountCmd)
|
||||
|
||||
/*
|
||||
|
|
|
|||
|
|
@ -21,10 +21,10 @@ import (
|
|||
"context"
|
||||
"fmt"
|
||||
|
||||
"code.superseriousbusiness.org/gotosocial/cmd/gotosocial/action"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/config"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/log"
|
||||
"github.com/spf13/cobra"
|
||||
"github.com/superseriousbusiness/gotosocial/cmd/gotosocial/action"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/config"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/log"
|
||||
)
|
||||
|
||||
type preRunArgs struct {
|
||||
|
|
@ -43,16 +43,16 @@ type preRunArgs struct {
|
|||
// env vars or cli flag.
|
||||
func preRun(a preRunArgs) error {
|
||||
if err := config.BindFlags(a.cmd); err != nil {
|
||||
return fmt.Errorf("error binding flags: %w", err)
|
||||
return fmt.Errorf("error binding flags: %s", err)
|
||||
}
|
||||
|
||||
if err := config.LoadConfigFile(); err != nil {
|
||||
return fmt.Errorf("error loading config file: %w", err)
|
||||
if err := config.Reload(); err != nil {
|
||||
return fmt.Errorf("error reloading config: %s", err)
|
||||
}
|
||||
|
||||
if !a.skipValidation {
|
||||
if err := config.Validate(); err != nil {
|
||||
return fmt.Errorf("invalid config: %w", err)
|
||||
return fmt.Errorf("invalid config: %s", err)
|
||||
}
|
||||
}
|
||||
|
||||
|
|
@ -64,17 +64,11 @@ func preRun(a preRunArgs) error {
|
|||
// context, after initializing any last-minute things like loggers etc.
|
||||
func run(ctx context.Context, action action.GTSAction) error {
|
||||
log.SetTimeFormat(config.GetLogTimestampFormat())
|
||||
|
||||
// Set the global log level from configuration.
|
||||
// Set the global log level from configuration
|
||||
if err := log.ParseLevel(config.GetLogLevel()); err != nil {
|
||||
return fmt.Errorf("error parsing log level: %w", err)
|
||||
}
|
||||
|
||||
// Set global log output format from configuration.
|
||||
if err := log.ParseFormat(config.GetLogFormat()); err != nil {
|
||||
return fmt.Errorf("error parsing log format: %w", err)
|
||||
}
|
||||
|
||||
if config.GetSyslogEnabled() {
|
||||
// Enable logging to syslog
|
||||
if err := log.EnableSyslog(
|
||||
|
|
|
|||
|
|
@ -18,8 +18,9 @@
|
|||
package main
|
||||
|
||||
import (
|
||||
configaction "code.superseriousbusiness.org/gotosocial/cmd/gotosocial/action/debug/config"
|
||||
"github.com/spf13/cobra"
|
||||
configaction "github.com/superseriousbusiness/gotosocial/cmd/gotosocial/action/debug/config"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/config"
|
||||
)
|
||||
|
||||
func debugCommands() *cobra.Command {
|
||||
|
|
@ -38,6 +39,7 @@ func debugCommands() *cobra.Command {
|
|||
return run(cmd.Context(), configaction.Config)
|
||||
},
|
||||
}
|
||||
config.AddServerFlags(debugConfigCmd)
|
||||
debugCmd.AddCommand(debugConfigCmd)
|
||||
return debugCmd
|
||||
}
|
||||
|
|
|
|||
|
|
@ -23,9 +23,10 @@ import (
|
|||
godebug "runtime/debug"
|
||||
"strings"
|
||||
|
||||
_ "code.superseriousbusiness.org/gotosocial/docs"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/config"
|
||||
"github.com/spf13/cobra"
|
||||
|
||||
_ "github.com/superseriousbusiness/gotosocial/docs"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/config"
|
||||
)
|
||||
|
||||
// Version is the version of GoToSocial being used.
|
||||
|
|
@ -40,22 +41,27 @@ func main() {
|
|||
// override version in config store
|
||||
config.SetSoftwareVersion(version)
|
||||
|
||||
rootCmd := new(cobra.Command)
|
||||
rootCmd.Use = "gotosocial"
|
||||
rootCmd.Short = "GoToSocial - a fediverse social media server"
|
||||
rootCmd.Long = "GoToSocial - a fediverse social media server\n\nFor help, see: https://docs.gotosocial.org.\n\nCode: https://codeberg.org/superseriousbusiness/gotosocial"
|
||||
rootCmd.Version = version
|
||||
rootCmd.SilenceErrors = true
|
||||
rootCmd.SilenceUsage = true
|
||||
// instantiate the root command
|
||||
rootCmd := &cobra.Command{
|
||||
Use: "gotosocial",
|
||||
Short: "GoToSocial - a fediverse social media server",
|
||||
Long: "GoToSocial - a fediverse social media server\n\nFor help, see: https://docs.gotosocial.org.\n\nCode: https://github.com/superseriousbusiness/gotosocial",
|
||||
Version: version,
|
||||
PersistentPreRunE: func(cmd *cobra.Command, args []string) error {
|
||||
// before running any other cmd funcs, we must load config-path
|
||||
return config.LoadEarlyFlags(cmd)
|
||||
},
|
||||
SilenceErrors: true,
|
||||
SilenceUsage: true,
|
||||
}
|
||||
|
||||
// Register global flags with root.
|
||||
config.RegisterGlobalFlags(rootCmd)
|
||||
// attach global flags to the root command so that they can be accessed from any subcommand
|
||||
config.AddGlobalFlags(rootCmd)
|
||||
|
||||
// Add subcommands with their flags.
|
||||
// add subcommands
|
||||
rootCmd.AddCommand(serverCommands())
|
||||
rootCmd.AddCommand(debugCommands())
|
||||
rootCmd.AddCommand(adminCommands())
|
||||
rootCmd.AddCommand(migrationCommands())
|
||||
|
||||
// Testrigcmd will only be set when debug is enabled.
|
||||
if testrigCmd := testrigCommands(); testrigCmd != nil {
|
||||
|
|
@ -64,7 +70,7 @@ func main() {
|
|||
log.Fatal("gotosocial must be built and run with the DEBUG enviroment variable set to enable and access testrig")
|
||||
}
|
||||
|
||||
// Run the prepared root command.
|
||||
// run
|
||||
if err := rootCmd.Execute(); err != nil {
|
||||
log.Fatalf("error executing command: %s", err)
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,43 +0,0 @@
|
|||
// 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/>.
|
||||
|
||||
package main
|
||||
|
||||
import (
|
||||
"code.superseriousbusiness.org/gotosocial/cmd/gotosocial/action/migration"
|
||||
"github.com/spf13/cobra"
|
||||
)
|
||||
|
||||
// migrationCommands returns the 'migrations' subcommand
|
||||
func migrationCommands() *cobra.Command {
|
||||
migrationCmd := &cobra.Command{
|
||||
Use: "migrations",
|
||||
Short: "gotosocial migrations-related tasks",
|
||||
}
|
||||
migrationRunCmd := &cobra.Command{
|
||||
Use: "run",
|
||||
Short: "starts and stops the database, running any outstanding migrations",
|
||||
PreRunE: func(cmd *cobra.Command, args []string) error {
|
||||
return preRun(preRunArgs{cmd: cmd})
|
||||
},
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
return run(cmd.Context(), migration.Run)
|
||||
},
|
||||
}
|
||||
migrationCmd.AddCommand(migrationRunCmd)
|
||||
return migrationCmd
|
||||
}
|
||||
|
|
@ -18,8 +18,9 @@
|
|||
package main
|
||||
|
||||
import (
|
||||
"code.superseriousbusiness.org/gotosocial/cmd/gotosocial/action/server"
|
||||
"github.com/spf13/cobra"
|
||||
"github.com/superseriousbusiness/gotosocial/cmd/gotosocial/action/server"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/config"
|
||||
)
|
||||
|
||||
// serverCommands returns the 'server' subcommand
|
||||
|
|
@ -38,19 +39,7 @@ func serverCommands() *cobra.Command {
|
|||
return run(cmd.Context(), server.Start)
|
||||
},
|
||||
}
|
||||
config.AddServerFlags(serverStartCmd)
|
||||
serverCmd.AddCommand(serverStartCmd)
|
||||
|
||||
serverMaintenanceCmd := &cobra.Command{
|
||||
Use: "maintenance",
|
||||
Short: "start the gotosocial server in maintenance mode (returns 503 for almost all requests)",
|
||||
PreRunE: func(cmd *cobra.Command, args []string) error {
|
||||
return preRun(preRunArgs{cmd: cmd})
|
||||
},
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
return run(cmd.Context(), server.Maintenance)
|
||||
},
|
||||
}
|
||||
serverCmd.AddCommand(serverMaintenanceCmd)
|
||||
|
||||
return serverCmd
|
||||
}
|
||||
|
|
|
|||
|
|
@ -18,14 +18,12 @@
|
|||
package main
|
||||
|
||||
import (
|
||||
"code.superseriousbusiness.org/gotosocial/cmd/gotosocial/action/testrig"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/config"
|
||||
"codeberg.org/gruf/go-debug"
|
||||
"github.com/spf13/cobra"
|
||||
"github.com/superseriousbusiness/gotosocial/cmd/gotosocial/action/testrig"
|
||||
)
|
||||
|
||||
func testrigCommands() *cobra.Command {
|
||||
if debug.DEBUG {
|
||||
if testrig.Start != nil {
|
||||
testrigCmd := &cobra.Command{
|
||||
Use: "testrig",
|
||||
Short: "gotosocial testrig-related tasks",
|
||||
|
|
@ -40,7 +38,6 @@ func testrigCommands() *cobra.Command {
|
|||
}
|
||||
|
||||
testrigCmd.AddCommand(testrigStartCmd)
|
||||
config.AddTestrig(testrigCmd)
|
||||
return testrigCmd
|
||||
}
|
||||
return nil
|
||||
|
|
|
|||
|
|
@ -24,15 +24,15 @@ import (
|
|||
"os/signal"
|
||||
"syscall"
|
||||
|
||||
"code.superseriousbusiness.org/gotosocial/internal/config"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/db/bundb"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/log"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/media"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/media/ffmpeg"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/state"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/storage"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/util"
|
||||
"codeberg.org/gruf/go-storage/memory"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/config"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/db/bundb"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/log"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/media"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/media/ffmpeg"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/state"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/storage"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/util"
|
||||
)
|
||||
|
||||
func main() {
|
||||
|
|
|
|||
|
|
@ -19,23 +19,19 @@ package main
|
|||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"io"
|
||||
"os"
|
||||
"os/signal"
|
||||
"strings"
|
||||
"syscall"
|
||||
"time"
|
||||
|
||||
"code.superseriousbusiness.org/gotosocial/internal/config"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/db/bundb"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/gtsmodel"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/log"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/media"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/media/ffmpeg"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/state"
|
||||
"code.superseriousbusiness.org/gotosocial/internal/storage"
|
||||
"codeberg.org/gruf/go-storage/memory"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/config"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/db/bundb"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/log"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/media"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/media/ffmpeg"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/state"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/storage"
|
||||
)
|
||||
|
||||
func main() {
|
||||
|
|
@ -43,7 +39,7 @@ func main() {
|
|||
ctx, cncl := signal.NotifyContext(ctx, syscall.SIGTERM, syscall.SIGINT)
|
||||
defer cncl()
|
||||
|
||||
log.SetLevel(log.ERROR)
|
||||
log.SetLevel(log.INFO)
|
||||
|
||||
if len(os.Args) != 4 {
|
||||
log.Panic(ctx, "Usage: go run ./cmd/process-media <input-file> <output-processed> <output-thumbnail>")
|
||||
|
|
@ -67,8 +63,7 @@ func main() {
|
|||
|
||||
var err error
|
||||
|
||||
config.SetProtocol("http")
|
||||
config.SetHost("localhost:8080")
|
||||
config.SetHost("example.com")
|
||||
config.SetStorageBackend("disk")
|
||||
config.SetStorageLocalBasePath("/tmp/gotosocial")
|
||||
config.SetDbType("sqlite")
|
||||
|
|
@ -114,7 +109,6 @@ func main() {
|
|||
log.Panic(ctx, err)
|
||||
}
|
||||
|
||||
outputCopyable(media)
|
||||
copyFile(ctx, &st, media.File.Path, os.Args[2])
|
||||
copyFile(ctx, &st, media.Thumbnail.Path, os.Args[3])
|
||||
}
|
||||
|
|
@ -142,104 +136,3 @@ func copyFile(ctx context.Context, st *storage.Driver, key string, path string)
|
|||
log.Panic(ctx, err)
|
||||
}
|
||||
}
|
||||
|
||||
func outputCopyable(media *gtsmodel.MediaAttachment) {
|
||||
var (
|
||||
now = time.Now()
|
||||
nowStr = now.Format(time.RFC3339)
|
||||
mediaType string
|
||||
fileMetaExtra string
|
||||
)
|
||||
|
||||
switch media.Type {
|
||||
case gtsmodel.FileTypeImage:
|
||||
mediaType = "gtsmodel.FileTypeImage"
|
||||
case gtsmodel.FileTypeVideo:
|
||||
mediaType = "gtsmodel.FileTypeVideo"
|
||||
case gtsmodel.FileTypeGifv:
|
||||
mediaType = "gtsmodel.FileTypeGifv"
|
||||
case gtsmodel.FileTypeAudio:
|
||||
mediaType = "gtsmodel.FileTypeAudio"
|
||||
case gtsmodel.FileTypeUnknown:
|
||||
mediaType = "gtsmodel.FileTypeUnknown"
|
||||
}
|
||||
|
||||
if media.FileMeta.Original.Duration != nil {
|
||||
fileMetaExtra += fmt.Sprintf("\n\t\t\tDuration: util.Ptr[float32](%f),", *media.FileMeta.Original.Duration)
|
||||
}
|
||||
if media.FileMeta.Original.Framerate != nil {
|
||||
fileMetaExtra += fmt.Sprintf("\n\t\t\tFramerate: util.Ptr[float32](%f),", *media.FileMeta.Original.Framerate)
|
||||
}
|
||||
if media.FileMeta.Original.Bitrate != nil {
|
||||
fileMetaExtra += fmt.Sprintf("\n\t\t\tBitrate: util.Ptr[uint64](%d),", *media.FileMeta.Original.Bitrate)
|
||||
}
|
||||
|
||||
fmt.Printf(`{
|
||||
ID: "%s",
|
||||
StatusID: "STATUS_ID_GOES_HERE",
|
||||
URL: "%s",
|
||||
RemoteURL: "",
|
||||
CreatedAt: TimeMustParse("%s"),
|
||||
Type: %s,
|
||||
FileMeta: gtsmodel.FileMeta{
|
||||
Original: gtsmodel.Original{
|
||||
Width: %d,
|
||||
Height: %d,
|
||||
Size: %d,
|
||||
Aspect: %f,%s
|
||||
},
|
||||
Small: gtsmodel.Small{
|
||||
Width: %d,
|
||||
Height: %d,
|
||||
Size: %d,
|
||||
Aspect: %f,
|
||||
},
|
||||
Focus: gtsmodel.Focus{
|
||||
X: 0,
|
||||
Y: 0,
|
||||
},
|
||||
},
|
||||
AccountID: "ACCOUNT_ID_GOES_HERE",
|
||||
Description: "DESCRIPTION_GOES_HERE",
|
||||
ScheduledStatusID: "",
|
||||
Blurhash: "%s",
|
||||
Processing: 2,
|
||||
File: gtsmodel.File{
|
||||
Path: "%s",
|
||||
ContentType: "%s",
|
||||
FileSize: %d,
|
||||
},
|
||||
Thumbnail: gtsmodel.Thumbnail{
|
||||
Path: "%s",
|
||||
ContentType: "%s",
|
||||
FileSize: %d,
|
||||
URL: "%s",
|
||||
RemoteURL: "",
|
||||
},
|
||||
Avatar: util.Ptr(false),
|
||||
Header: util.Ptr(false),
|
||||
Cached: util.Ptr(true),
|
||||
}`+"\n",
|
||||
media.ID,
|
||||
strings.ReplaceAll(media.URL, media.AccountID, "ACCOUNT_ID_GOES_HERE"),
|
||||
nowStr,
|
||||
mediaType,
|
||||
media.FileMeta.Original.Width,
|
||||
media.FileMeta.Original.Height,
|
||||
media.FileMeta.Original.Size,
|
||||
media.FileMeta.Original.Aspect,
|
||||
fileMetaExtra,
|
||||
media.FileMeta.Small.Width,
|
||||
media.FileMeta.Small.Height,
|
||||
media.FileMeta.Small.Size,
|
||||
media.FileMeta.Small.Aspect,
|
||||
media.Blurhash,
|
||||
strings.ReplaceAll(media.File.Path, media.AccountID, "ACCOUNT_ID_GOES_HERE"),
|
||||
media.File.ContentType,
|
||||
media.File.FileSize,
|
||||
strings.ReplaceAll(media.Thumbnail.Path, media.AccountID, "ACCOUNT_ID_GOES_HERE"),
|
||||
media.Thumbnail.ContentType,
|
||||
media.Thumbnail.FileSize,
|
||||
strings.ReplaceAll(media.Thumbnail.URL, media.AccountID, "ACCOUNT_ID_GOES_HERE"),
|
||||
)
|
||||
}
|
||||
|
|
|
|||
|
|
@ -178,7 +178,7 @@ hooks:
|
|||
|
||||
For PostgreSQL, you'll want to use `postgresql_databases` instead.
|
||||
|
||||
The file mentioned in `patterns_from` can be created by transforming the output from the GoToSocial CLI media [`list-attachments`](cli.md#gotosocial-admin-media-list-attachments) and [`list-emojis`](cli.md#gotosocial-admin-media-list-emojis) commands. In order to generate the right patterns you can use the [`media-to-borg-patterns.py`](https://codeberg.org/superseriousbusiness/gotosocial/tree/main/example/borgmatic/media-to-borg-patterns.py) script. How Borg patterns work is explained in [their documentation](https://man.archlinux.org/man/borg-patterns.1).
|
||||
The file mentioned in `patterns_from` can be created by transforming the output from the GoToSocial CLI media [`list-attachments`](cli.md#gotosocial-admin-media-list-attachments) and [`list-emojis`](cli.md#gotosocial-admin-media-list-emojis) commands. In order to generate the right patterns you can use the [`media-to-borg-patterns.py`](https://github.com/superseriousbusiness/gotosocial/tree/main/example/borgmatic/media-to-borg-patterns.py) script. How Borg patterns work is explained in [their documentation](https://man.archlinux.org/man/borg-patterns.1).
|
||||
|
||||
You'll need to put that file on your GoToSocial instance and make sure the file is executable. It requires Python 3 which you will already have if you have Borg and Borgmatic installed. It only depends on the Python standard library.
|
||||
|
||||
|
|
@ -186,7 +186,7 @@ You'll need to put that file on your GoToSocial instance and make sure the file
|
|||
For this to work reliably, you should ensure that the [storage-local-base-path](../configuration/storage.md) in your GoToSocial configuration uses an absolute path. Otherwise you'll have to tweak the paths yourself.
|
||||
|
||||
```sh
|
||||
$ gotosocial --config-path /path/to/config.yaml admin media list-attachments --local-only | \
|
||||
$ gotosocial admin media list-attachments --local-only | \
|
||||
/path/to/media-to-borg-patterns.py \
|
||||
<storage-local-base-path>
|
||||
```
|
||||
|
|
@ -210,7 +210,7 @@ If you're running Borgmatic as a systemd service, you can [create a drop-in](htt
|
|||
|
||||
```ini
|
||||
[Service]
|
||||
ExecStartPre=/path/to/gotosocial --config-path /path/to/config.yaml admin media list-attachments --local-only | /path/to/media-to-borg-patterns.py <storage-local-base-path> /etc/borgmatic/gotosocial_patterns
|
||||
ExecStartPre=/path/to/gotosocial admin media list-attachments --local-only | /path/to/media-to-borg-patterns.py <storage-local-base-path> /etc/borgmatic/gotosocial_patterns
|
||||
```
|
||||
|
||||
Documentation that's good to review:
|
||||
|
|
|
|||
|
|
@ -13,7 +13,7 @@ GoToSocial - a fediverse social media server
|
|||
|
||||
For help, see: https://docs.gotosocial.org.
|
||||
|
||||
Code: https://codeberg.org/superseriousbusiness/gotosocial
|
||||
Code: https://github.com/superseriousbusiness/gotosocial
|
||||
|
||||
Usage:
|
||||
gotosocial [command]
|
||||
|
|
@ -57,9 +57,6 @@ Contains `account`, `export`, `import`, and `media` subcommands.
|
|||
|
||||
This command can be used to create a new account on your instance.
|
||||
|
||||
!!! Warning
|
||||
You must have launched the server at least once before running this command, to initialize essential entries in the database.
|
||||
|
||||
`gotosocial admin account create --help`:
|
||||
|
||||
```text
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
GoToSocial supports 'blocking'/'suspending' domains that you don't want your instance to federate with. In our documentation, the two terms 'block' and 'suspend' are used interchangeably with regard to domains, because they mean the same thing: preventing your instance and the instance running on the target domain from communicating with one another, effectively cutting off federation between the two instances.
|
||||
|
||||
You can view, create, and remove domain blocks and domain allows using the [instance admin panel](./settings.md#domain-permissions).
|
||||
You can view, create, and remove domain blocks and domain allows using the [instance admin panel](./settings.md#federation).
|
||||
|
||||
This document focuses on what domain blocks actually *do* and what side effects are processed when you create a new domain block.
|
||||
|
||||
|
|
@ -41,9 +41,9 @@ With this in mind, you should only ever treat domain blocking as *one layer* of
|
|||
|
||||
Unfortunately, the Fediverse has its share of trolls, many of whom see domain blocking as an adversary to be defeated. To achieve this, they often target instances which use domain blocks to protect users.
|
||||
|
||||
As such, there are bots on the Fediverse which scrape instance domain blocks and announce any discovered blocks to the followers of the bot, opening the admin of the blocking instance up to harassment. These bots use the `api/v1/instance/peers?filter=suspended`, `api/v1/instance/peers?filter=blocked`, and/or `api/v1/instance/domain_blocks` endpoints of GoToSocial instances to gather domain block information.
|
||||
As such, there are bots on the Fediverse which scrape instance domain blocks and announce any discovered blocks to the followers of the bot, opening the admin of the blocking instance up to harassment. These bots use the `api/v1/instance/peers?filter=suspended` endpoint of GoToSocial instances to gather domain block information.
|
||||
|
||||
By default, GoToSocial does not expose these endpoints publicly, so your instance will be safe from such scraping. However, if you set `instance-expose-blocklist` to `true` in your config.yaml file, you may find that these endpoints gets scraped occasionally, and you may see your blocks being announced by troll bots.
|
||||
By default, GoToSocial does not expose this endpoint publicly, so your instance will be safe from such scraping. However, if you set `instance-expose-suspended` to `true` in your config.yaml file, you may find that this endpoint gets scraped occasionally, and you may see your blocks being announced by troll bots.
|
||||
|
||||
## What are the side effects of creating a domain block
|
||||
|
||||
|
|
|
|||
|
|
@ -1,185 +0,0 @@
|
|||
# Domain Permission Subscriptions
|
||||
|
||||
Via the [admin settings panel](./settings.md#subscriptions), you can create and manage domain permission subscriptions.
|
||||
|
||||
Domain permission subscriptions allow you to specify a URL at which a permission list is hosted. Every 24hrs at 11pm (by default), your instance will fetch and parse each list you're subscribed to, in order of priority (highest to lowest), and create domain permissions (or domain permission drafts) based on entries discovered in the lists.
|
||||
|
||||
Each domain permission subscription can be used to create domain allow or domain block entries.
|
||||
|
||||
!!! warning
|
||||
Currently, via blocklist subscriptions it is only possible to create "suspend" level domain blocks; other severities are not yet supported. Entries of severity "silence" or "limit" etc. on subscribed blocklists will be skipped.
|
||||
|
||||
## Priority
|
||||
|
||||
When you specify multiple domain permission subscriptions, they will be fetched and parsed in order of priority, from highest priority (255) to lowest priority (0).
|
||||
|
||||
Permissions discovered on lists higher up in the priority ranking will override permissions on lists lower down in the priority ranking.
|
||||
|
||||
For example, an instance admin subscribes to two allow lists, "Important List" at priority 255, and "Less Important List" at priority 128. Each of these subscribed lists contain an entry for `good-eggs.example.org`.
|
||||
|
||||
The subscription with the higher priority is the one that now creates and manages the domain allow entry for `good-eggs.example.org`.
|
||||
|
||||
If the subscription with the higher priority is removed, then the next time all the subscriptions are fetched, "Less Important List" will create (or take ownership of) the domain allow instead.
|
||||
|
||||
## Retractions
|
||||
|
||||
Sometimes, an entry that was present on a subscribed block or allow list will be removed later by the curator(s) of that list. When this happens, the removed domain permission entry can be said to have been "retracted".
|
||||
|
||||
For example, say your instance subscribes to one block list, and that block list contains an entry for `baddies.example.org`. A corresponding domain block for `baddies.example.org` has therefore been created in your database, with the subscription ID of your block list. In other words, the domain block is in force, and is managed by your block list subscription.
|
||||
|
||||
At some point, your instance fetches the list again, and this time it sees that the entry for `baddies.example.org` is no longer present in the list, because it has been removed by the list curator(s) (perhaps the admins turned their policies around, or the instance was shut down, etc). Thus, according to your instance, the block for `baddies.example.org` is now a "retracted" domain permission entry.
|
||||
|
||||
If the domain permission subscription is set to "Remove retracted permissions," then the now-retracted domain block will be removed from the database, and will no longer be enforced. In this example, that means your instance will start federating (again) with `baddies.example.org`.
|
||||
|
||||
If the domain permission subscription is *not* set to "Remove retracted permissions," then instead of the retracted block being removed from the database, it will be kept in the database but "orphaned" -- ie., it will still be in force, but it will be marked as no longer being managed by the subscription. In this example, that means your instance will keep blocking `baddies.example.org`.
|
||||
|
||||
!!!! Note "Retracted permissions and other subscriptions"
|
||||
When a permission is retracted and removed from the database, but an entry for it exists on the list of *another* subscription of a lower priority than the one it was retracted from, then the permission will be recreated as an entry managed by the lower priority list.
|
||||
|
||||
For example, say you subscribe to List1 at priority 255, and List2 at priority 128, and `baddies.example.org` is present on both lists. That means the domain block entry will be managed by List1. If List1 later *retracts* the entry, it will be removed from your database (assuming you have "Remove retracted permissions" set). However, as soon as List2 is checked (usually seconds after List1), then an entry for `baddies.example.org` will be created again, but managed by List2 this time.
|
||||
|
||||
In other words, it is only when an entry is retracted from *every list you subscribe to* that it will truly be removed.
|
||||
|
||||
## Orphan Permissions
|
||||
|
||||
Domain permissions (blocks or allows) that are not currently managed by a domain permission subscription are considered "orphan" permissions. This includes permissions that an admin created in the settings panel by hand, entries which were imported manually via the import/export page, or entries that belonged to a subscription but have since been retracted but not removed.
|
||||
|
||||
If you wish, when creating a domain permission subscription, you can set ["adopt orphans"](./settings.md#adopt-orphan-permissions) to true for that subscription. If a domain permission subscription that is set to adopt orphans encounters an orphan permission which is *also present on the list at the subscription's URI*, then it will "adopt" the orphan by setting the orphan's subscription ID to its own ID.
|
||||
|
||||
For example, an instance admin manually creates a domain block for the domain `horrid-trolls.example.org`. Later, they create a domain permission subscription for a block list that contains an entry for `horrid-trolls.example.org`, and they set "adopt orphans" to true. When their instance fetches and parses the list, and creates domain permission entries from it, then the orphan domain block for `horrid-trolls.example.org` gets adopted by the domain permission subscription. Now, if the domain permission subscription is removed, and the option to remove all permissions owned by the subscription is checked, then the domain block for `horrid-trolls.example.org` will also be removed.
|
||||
|
||||
## Fun Stuff To Do With Domain Permission Subscriptions
|
||||
|
||||
### 1. Create an allowlist-federation cluster.
|
||||
|
||||
Domain permission subscriptions make it possible to easily create allowlist-federation clusters, ie., a group of instances can essentially form their own mini-fediverse, wherein each instance runs in [allowlist federation mode](./federation_modes.md#allowlist-federation-mode), and subscribes to a cooperatively-managed allowlist hosted somewhere.
|
||||
|
||||
For example, instances `instance-a.example.org`, `instance-b.example.org`, and `instance-c.example.org` decide that they only want to federate with each other.
|
||||
|
||||
Using some version management platform like Codeberg, they host a plaintext-formatted allowlist at something like `https://codeberg.org/our-cluster/allowlist/raw/branch/main/allows.txt`.
|
||||
|
||||
The contents of the plaintext-formatted allowlist are as follows:
|
||||
|
||||
```text
|
||||
instance-a.example.org
|
||||
instance-b.example.org
|
||||
instance-c.example.org
|
||||
```
|
||||
|
||||
Each instance admin sets their federation mode to `allowlist`, and creates a subscription to create allows from `https://codeberg.org/our-cluster/allowlist/raw/branch/main/allows.txt`, which results in domain allow entries being created for their own domain, and for each other domain in the cluster.
|
||||
|
||||
At some point, someone from `instance-d.example.org` asks (out of band) whether they can be added to the cluster. The existing admins agree, and update their plaintext-formatted allowlist to read:
|
||||
|
||||
```text
|
||||
instance-a.example.org
|
||||
instance-b.example.org
|
||||
instance-c.example.org
|
||||
instance-d.example.org
|
||||
```
|
||||
|
||||
The next time each instance fetches the list, a new domain allow entry will be created for `instance-d.example.org`, and it will be able to federate with the other domains on the list.
|
||||
|
||||
### 2. Cooperatively manage a blocklist.
|
||||
|
||||
Domain permission subscriptions make it easy to collaborate on and subscribe to shared blocklists of domains that host illegal / fashy / otherwise undesired accounts and content.
|
||||
|
||||
For example, the admins of instances `instance-e.example.org`, `instance-f.example.org`, and `instance-g.example.org` decide that they are tired of duplicating work by playing whack-a-mole with bad actors. To make their lives easier, they decide to collaborate on a shared blocklist.
|
||||
|
||||
Using some version management platform like Codeberg, they host a blocklist at something like `https://codeberg.org/our-cluster/allowlist/raw/branch/main/blocks.csv`.
|
||||
|
||||
When someone discovers a new domain hosting an instance they don't like, they can open a pull request or similar against the list, to add the questionable instance to the domain.
|
||||
|
||||
For example, someone gets an unpleasant reply from a new instance `fashy-arseholes.example.org`. Using their collaboration tools, they propose adding `fashy-arseholes.example.org` to the blocklist. After some deliberation and discussion, the domain is added to the list.
|
||||
|
||||
The next time each of `instance-e.example.org`, `instance-f.example.org`, and `instance-g.example.org` fetch the block list, a block entry will be created for ``fashy-arseholes.example.org``.
|
||||
|
||||
### 3. Subscribe to a blocklist, but ignore some of it.
|
||||
|
||||
Say that `instance-g.example.org` in the previous section decides that they agree with most of the collaboratively-curated blocklist, but they actually would like to keep federating with ``fashy-arseholes.example.org`` for some godforsaken reason.
|
||||
|
||||
This can be done in one of three ways:
|
||||
|
||||
1. The admin of `instance-g.example.org` subscribes to the shared blocklist, but they do so with the ["create as drafts"](./settings.md#create-permissions-as-drafts) option set to true. When their instance fetches the blocklist, a draft block is created for `fashy-arseholes.example.org`. The admin of `instance-g` just leaves the permission as a draft, or rejects it, so it never comes into force.
|
||||
2. Before the blocklist is re-fetched, the admin of `instance-g.example.org` creates a [domain permission exclude](./settings.md#excludes) entry for ``instance-g.example.org``. The domain ``instance-g.example.org`` then becomes exempt/excluded from automatic permission creation, and so the block for ``instance-g.example.org`` on the shared blocklist does not get created in the database of ``instance-g.example.org`` the next time the list is fetched.
|
||||
3. The admin of `instance-g.example.org` creates an explicit domain allow entry for `fashy-arseholes.example.org` on their own instance. Because their instance is running in `blocklist` federation mode, [the explicit allow overrides the domain block entry](./federation_modes.md#in-blocklist-mode), and so the domain remains unblocked.
|
||||
|
||||
### 4. Subscribe directly to another instance's blocklist.
|
||||
|
||||
Because GoToSocial is able to fetch and parse JSON-formatted lists of domain permissions, it is possible to subscribe directly to another instance's list of blocked domains via their `/api/v1/instance/domain_blocks` (Mastodon) or `/api/v1/instance/peers?filter=suspended` (GoToSocial) endpoint (if exposed).
|
||||
|
||||
For example, the Mastodon instance `peepee.poopoo.example.org` exposes their block list publicly, and the owner of the GoToSocial instance `instance-h.example.org` decides they quite like the cut of the Mastodon moderator's jib. They create a domain permission subscription of type JSON, and set the URI to `https://peepee.poopoo.example.org/api/v1/instance/domain_blocks`. Every 24 hours, their instance will go fetch the blocklist JSON from the Mastodon instance, and create permissions based on entries discovered therein.
|
||||
|
||||
## Example lists per content type
|
||||
|
||||
Shown below are examples of the different permission list formats that GoToSocial is able to understand and parse.
|
||||
|
||||
Each list contains three domains, `bumfaces.net`, `peepee.poopoo`, and `nothanks.com`.
|
||||
|
||||
### CSV
|
||||
|
||||
CSV lists use content type `text/csv`.
|
||||
|
||||
Mastodon domain permission exports generally use this format.
|
||||
|
||||
```csv
|
||||
#domain,#severity,#reject_media,#reject_reports,#public_comment,#obfuscate
|
||||
bumfaces.net,suspend,false,false,big jerks,false
|
||||
peepee.poopoo,suspend,false,false,harassment,false
|
||||
nothanks.com,suspend,false,false,,false
|
||||
```
|
||||
|
||||
### JSON (application/json)
|
||||
|
||||
JSON lists use content type `application/json`.
|
||||
|
||||
```json
|
||||
[
|
||||
{
|
||||
"domain": "bumfaces.net",
|
||||
"suspended_at": "2020-05-13T13:29:12.000Z",
|
||||
"comment": "big jerks"
|
||||
},
|
||||
{
|
||||
"domain": "peepee.poopoo",
|
||||
"suspended_at": "2020-05-13T13:29:12.000Z",
|
||||
"comment": "harassment"
|
||||
},
|
||||
{
|
||||
"domain": "nothanks.com",
|
||||
"suspended_at": "2020-05-13T13:29:12.000Z"
|
||||
}
|
||||
]
|
||||
```
|
||||
|
||||
As an alternative to `"comment"`, `"public_comment"` will also work:
|
||||
|
||||
```json
|
||||
[
|
||||
{
|
||||
"domain": "bumfaces.net",
|
||||
"suspended_at": "2020-05-13T13:29:12.000Z",
|
||||
"public_comment": "big jerks"
|
||||
},
|
||||
{
|
||||
"domain": "peepee.poopoo",
|
||||
"suspended_at": "2020-05-13T13:29:12.000Z",
|
||||
"public_comment": "harassment"
|
||||
},
|
||||
{
|
||||
"domain": "nothanks.com",
|
||||
"suspended_at": "2020-05-13T13:29:12.000Z"
|
||||
}
|
||||
]
|
||||
```
|
||||
|
||||
### Plaintext (text/plain)
|
||||
|
||||
Plaintext lists use content type `text/plain`.
|
||||
|
||||
Note that it is not possible to include any fields like "obfuscate" or "public comment" in plaintext lists, as they are simply a newline-separated list of domains.
|
||||
|
||||
```text
|
||||
bumfaces.net
|
||||
peepee.poopoo
|
||||
nothanks.com
|
||||
```
|
||||
|
|
@ -31,18 +31,13 @@ When your instance encounters a mention or an announce of a status or account it
|
|||
|
||||
## Combining blocks and allows
|
||||
|
||||
!!! danger
|
||||
Combining blocks and allows is a tricky business!
|
||||
It is possible to both block and allow the same domain, and the effect of combining these two things depends on which federation mode your instance is currently using.
|
||||
|
||||
When importing lists of allows and blocks, you should always review the list manually to make sure that you do not inadvertently block a domain that you would prefer not to block, since this can have **very annoying side effects** like removing follows/following, statuses, etc.
|
||||
|
||||
When in doubt, always add an explicit allow first as an insurance policy!
|
||||
|
||||
It is possible to both block and allow the same domain, and the effect of combining these two things depends on which federation mode your instance is currently using, as explained in the following subsections, which are summarised in a flowchart that you can find below.
|
||||

|
||||
|
||||
### In blocklist mode
|
||||
|
||||
As the chart below shows, in blocklist mode (the left-hand part of the diagram), an explicit domain allow can be used to override a domain block.
|
||||
As the chart shows, in blocklist mode (the left-hand part of the diagram), an explicit domain allow can be used to override a domain block.
|
||||
|
||||
This is useful in cases where you are importing a blocklist from someone else, but the imported blocklist contains some instances you would actually prefer not to block. To avoid blocking those instances, you can create explicit domain allows for those instances first. Then, when you import the block list, the explicitly allowed domains will not be blocked, and the side effects of creating a block (deleting statuses, media, relationships etc) will not be processed.
|
||||
|
||||
|
|
@ -52,11 +47,16 @@ Conversely, if you add an explicit allow for a domain that was blocked, the side
|
|||
|
||||
### In allowlist mode
|
||||
|
||||
As the chart below shows, in allowlist mode (the right-hand part of the diagram) an explicit domain block trumps an explicit domain allow. The following two things must be true in order for an instance to be allowed through, when running in allowlist mode:
|
||||
As the chart shows, in allowlist mode (the right-hand part of the diagram) an explicit domain block trumps an explicit domain allow. The following two things must be true in order for an instance to be allowed through, when running in allowlist mode:
|
||||
|
||||
1. An explicit domain block **does not exist** for the instance.
|
||||
2. An explicit domain allow **does exist** for the instance.
|
||||
|
||||
If either of the above conditions are not met, the request will be denied.
|
||||
|
||||

|
||||
!!! danger
|
||||
Combining blocks and allows is a tricky business!
|
||||
|
||||
When importing lists of allows and blocks, you should always review the list manually to make sure that you do not inadvertently block a domain that you would prefer not to block, since this can have **very annoying side effects** like removing follows/following, statuses, etc.
|
||||
|
||||
When in doubt, always add an explicit allow first as an insurance policy!
|
||||
|
|
|
|||
|
|
@ -2,14 +2,12 @@
|
|||
|
||||
GoToSocial serves a `robots.txt` file on the host domain. This file contains rules that attempt to block known AI scrapers, as well as some other indexers. It also includes some rules to ensure things like API endpoints aren't indexed by search engines since there really isn't any point to them.
|
||||
|
||||
## Allow/disallow stats collection
|
||||
|
||||
You can allow or disallow crawlers from collecting stats about your instance from the `/nodeinfo/2.0` and `/nodeinfo/2.1` endpoints by changing the setting `instance-stats-mode`, which modifies the `robots.txt` file. See [instance configuration](../configuration/instance.md) for more details.
|
||||
|
||||
## AI scrapers
|
||||
|
||||
The AI scrapers come from a [community maintained repository][airobots]. It's manually kept in sync for the time being. If you know of any missing robots, please send them a PR!
|
||||
|
||||
A number of AI scrapers are known to ignore entries in `robots.txt` even if it explicitly matches their User-Agent. This means the `robots.txt` file is not a foolproof way of ensuring AI scrapers don't grab your content. In addition to this you might want to look into blocking User-Agents via [requester header filtering](request_filtering_modes.md).
|
||||
A number of AI scrapers are known to ignore entries in `robots.txt` even if it explicitly matches their User-Agent. This means the `robots.txt` file is not a foolproof way of ensuring AI scrapers don't grab your content.
|
||||
|
||||
If you want to block these things fully, you'll need to block based on the User-Agent header in a reverse proxy until GoToSocial can filter requests by User-Agent header.
|
||||
|
||||
[airobots]: https://github.com/ai-robots-txt/ai.robots.txt/
|
||||
|
|
|
|||
|
|
@ -20,13 +20,13 @@ Instance moderation settings.
|
|||
|
||||
### Reports
|
||||
|
||||

|
||||

|
||||
|
||||
The reports section shows a list of reports, originating from your local users, or remote instances (shown anonymously as just the name of the instance, without specific username).
|
||||
|
||||
Clicking a report shows if it was resolved (with the reasoning if available), more information, and a list of reported toots if selected by the reporting user. You can also use this view to mark a report as resolved, and fill in a comment. Whatever comment you enter here will be visible to the user that created the report, if that user is from your instance.
|
||||
|
||||

|
||||

|
||||
|
||||
Clicking on the username of the reported account opens that account in the 'Accounts' view, allowing you to perform moderation actions on it.
|
||||
|
||||
|
|
@ -34,11 +34,11 @@ Clicking on the username of the reported account opens that account in the 'Acco
|
|||
|
||||
You can use this section to search for an account and perform moderation actions on it.
|
||||
|
||||
### Domain Permissions
|
||||
### Federation
|
||||
|
||||

|
||||

|
||||
|
||||
In the domain permissions section you can create, delete, and review domain blocks, domain allows, drafts, excludes, and subscriptions.
|
||||
In the federation section you can create, delete, and review explicit domain blocks and domain allows.
|
||||
|
||||
For more detail on federation settings, and specifically how domain allows and domain blocks work in combination, please see [the federation modes section](./federation_modes.md), and [the domain blocks section](./domain_blocks.md).
|
||||
|
||||
|
|
@ -46,105 +46,20 @@ For more detail on federation settings, and specifically how domain allows and d
|
|||
|
||||
You can enter a domain to suspend in the search field, which will filter the list to show you if you already have a block for it.
|
||||
|
||||
Clicking 'suspend' gives you a form to add a public and/or private comment, and submit to add the block.
|
||||
|
||||
Adding a domain block will suspend all currently known accounts from that domain, and prevent any new interactions with the blocked domain.
|
||||
Clicking 'suspend' gives you a form to add a public and/or private comment, and submit to add the block. Adding a suspension will suspend all the currently known accounts on the instance, and prevent any new interactions with any user on the blocked instance.
|
||||
|
||||
#### Domain Allows
|
||||
|
||||
The domain allows section works much like the domain blocks section, described above, only for explicit domain allows rather than domain blocks.
|
||||
|
||||
#### Import/export
|
||||
#### Bulk import/export
|
||||
|
||||
In this section you can do bulk import/export of domain permissions in JSON, CSV, or plaintext formats.
|
||||
Through the link at the bottom of the Federation section (or going to `/settings/admin/federation/import-export`) you can do bulk import/export of blocklists and allowlists.
|
||||
|
||||

|
||||

|
||||
|
||||
Upon importing a list, either through the input field or from a file, you can review the entries in the list before importing a subset. You'll also be warned for entries that use subdomains, providing an easy way to change them to the main domain.
|
||||
|
||||
#### Drafts
|
||||
|
||||
In this section you can create, search through, accept, and reject domain permission drafts.
|
||||
|
||||
Domain permission drafts are domain permissions that have been proposed (either via manual creation or as an entry from a subscribed block / allow list), but have not yet come into force.
|
||||
|
||||
Until it is accepted, a domain permission draft will not have any effect on federation with the domain it targets. Upon acceptance, it will be converted into either a domain block or a domain allow, and start being enforced.
|
||||
|
||||
#### Excludes
|
||||
|
||||
In this section, you can create, search through, and remove domain permission excludes.
|
||||
|
||||
Domain permission excludes prevent permissions for a domain (and all subdomains) from being automatically managed by domain permission subscriptions.
|
||||
|
||||
For example, if you create an exclude entry for the domain `example.org`, then a blocklist or allowlist subscription will exclude entries for `example.org` and any of its subdomains (`sub.example.org`, `another.sub.example.org` etc.) when creating domain permission drafts and domain blocks/allows.
|
||||
|
||||
This functionality allows you to manually manage permissions for excluded domains, in cases where you know you definitely do or don't want to federate with a given domain, no matter what entries are contained in a domain permission subscription.
|
||||
|
||||
Note that by itself, creation of an exclude entry for a given domain does not affect federation with that domain at all, it is only useful in combination with permission subscriptions.
|
||||
|
||||
#### Subscriptions
|
||||
|
||||
In this section, you can create, search through, edit, test, and remove domain permission subscriptions.
|
||||
|
||||
Domain permission subscriptions allow you to specify a URL at which a permission list is hosted. Every 24hrs at 11pm (by default), your instance will fetch and parse each subscribed list, and create domain permissions (or domain permission drafts) based on entries in the lists.
|
||||
|
||||
##### Title
|
||||
|
||||
You can optionally use the title field to set a title for the subscription, as a reminder for yourself and other admins.
|
||||
|
||||
For example, you might subscribe to a list at `https://lists.example.org/baddies.csv` and set the title of the subscription to something that reflects the contents of that list, such as "Basic block list (worst of the worst)", or similar.
|
||||
|
||||
##### Subscription Priority
|
||||
|
||||
When you specify multiple domain permission subscriptions, they will be fetched and parsed in order of priority, from highest priority (255) to lowest priority (0).
|
||||
|
||||
Permissions discovered on lists higher up in the priority ranking will override permissions on lists lower down in the priority ranking.
|
||||
|
||||
For more information on priority, please see the separate [domain permission subscriptions](./domain_permission_subscriptions.md) document.
|
||||
|
||||
##### Permission Type
|
||||
|
||||
You can use this dropdown to select whether permissions discovered at the list URL should be created as domain blocks, or domain allows.
|
||||
|
||||
##### Content Type
|
||||
|
||||
You can use this dropdown to select the content type of the list at the subscribed URL.
|
||||
|
||||
Use CSV for Mastodon-style permission lists, plain for plaintext lists of domain names, or JSON for json-exported lists.
|
||||
|
||||
##### Basic Auth
|
||||
|
||||
Check this box to provide a basic auth username and/or password credential for the subscribed list, which will be sent along with each request to fetch the list.
|
||||
|
||||
##### Adopt Orphan Permissions
|
||||
|
||||
If you check this box, then any existing domain permissions will become managed by this subscription in the following circumstances:
|
||||
|
||||
1. They don't already have a subscription ID (ie., they're not managed by any domain permission subscription).
|
||||
2. They match a domain permission included in the list at the URL of this subscription.
|
||||
|
||||
For more information on orphan permissions, please see the separate [domain permission subscriptions](./domain_permission_subscriptions.md#orphan-permissions) document.
|
||||
|
||||
##### Remove Retracted Permissions
|
||||
|
||||
This setting controls how retractions are handled by this domain permission subscription: if "Remove retracted permissions" is checked, retracted entries will be removed from the database; if "Remove retracted permissions" is not checked, retracted entries will just be orphaned instead.
|
||||
|
||||
For more detail on how retractions work, with examples, please see the separate [domain permission subscriptions](./domain_permission_subscriptions.md#retractions) document.
|
||||
|
||||
##### Create Permissions as Drafts
|
||||
|
||||
With this box checked (default), any permissions created by this subscription will be created as **drafts** which require manual approval to come into force.
|
||||
|
||||
It is recommended to leave this box checked unless you absolutely trust the subscribed list, to avoid inadvertent blocking or allowing of domains you'd rather not block or allow.
|
||||
|
||||
##### Test a Subscription
|
||||
|
||||
To test whether a subscription can be successfully parsed, first create the subscription, then in the detailed view for that subscription, click on the "Test" button.
|
||||
|
||||
If your instance is able to fetch and parse permissions at the subscription URI, then you will see a list of these after clicking "Test". Otherwise, you will see an error message.
|
||||
|
||||

|
||||
|
||||
## Administration
|
||||
|
||||
Instance administration settings.
|
||||
|
|
@ -171,7 +86,7 @@ Custom Emoji will be automatically fetched when included in remote toots, but to
|
|||
|
||||
#### Local
|
||||
|
||||

|
||||

|
||||
|
||||
This section shows an overview of all the custom emoji enabled on your instance, sorted by their category. Clicking an emoji shows it's details, and provides options to change the category or image, or delete it completely. The shortcode cannot be updated here, you would have to upload it with the new shortcode yourself (and optionally delete the old one).
|
||||
|
||||
|
|
@ -179,7 +94,7 @@ Below the overview you can upload your own custom emoji, after previewing how th
|
|||
|
||||
#### Remote
|
||||
|
||||

|
||||

|
||||
|
||||
Through the 'remote' section, you can look up a link to any remote toots (provided the instance isn't suspended). If they use any custom emoji they will be listed, providing an easy way to copy them to the local emoji (for use in your own toots), or disable them ( hiding them from toots).
|
||||
|
||||
|
|
@ -187,7 +102,7 @@ Through the 'remote' section, you can look up a link to any remote toots (provid
|
|||
|
||||
### Instance Settings
|
||||
|
||||

|
||||

|
||||
|
||||
Here you can set various metadata for your instance, like the displayed name/title, thumbnail image, (short) description, and contact info.
|
||||
|
||||
|
|
@ -252,11 +167,3 @@ Links to the set contact account and/or email address will appear on the footer
|
|||
The selected **contact user** must be an active (not suspended) admin and/or moderator on the instance.
|
||||
|
||||
If you're on a single-user instance and you give admin privileges to your main account, you can just fill in your own username here; you don't need to make a separate admin account just for this.
|
||||
|
||||
### Instance Custom CSS
|
||||
|
||||
custom CSS allows you to further customize the way your instance looks when visited through a browser.
|
||||
|
||||
This custom CSS will be applied to all pages of your instance. Users themes and CSS still take precedence over this customization.
|
||||
|
||||
See the [Custom CSS](../user_guide/custom_css.md) page for some tips on writing custom CSS for your instance.
|
||||
|
|
|
|||
|
|
@ -17,7 +17,7 @@ You can open new account sign-ups for your instance by changing the variable `ac
|
|||
|
||||
A sign-up form for your instance will be available at the `/signup` endpoint. For example, `https://your-instance.example.org/signup`.
|
||||
|
||||

|
||||

|
||||
|
||||
Also, your instance homepage and "about" pages will be updated to reflect that registrations are open.
|
||||
|
||||
|
|
@ -29,11 +29,11 @@ In the meantime, admins and moderators on your instance will receive an email an
|
|||
|
||||
Instance admins and moderators can handle a new sign-up by either approving or rejecting it via the "accounts" -> "pending" section in the admin panel.
|
||||
|
||||

|
||||

|
||||
|
||||
If you have no sign-ups, the list pictured above will be empty. If you have a pending account sign-up, however, you can click on it to open that account in the account details screen:
|
||||
|
||||

|
||||

|
||||
|
||||
At the bottom, you will find actions that let you approve or reject the sign-up.
|
||||
|
||||
|
|
@ -46,14 +46,12 @@ If you **reject** the sign-up, you may wish to inform the applicant that their s
|
|||
|
||||
## Sign-Up Limits
|
||||
|
||||
By default, to avoid sign-up backlogs overwhelming admins and moderators, GoToSocial limits the sign-up pending backlog to 20 accounts. Once there are 20 accounts pending in the backlog waiting to be handled by an admin or moderator, new sign-ups will not be accepted via the form.
|
||||
To avoid sign-up backlogs overwhelming admins and moderators, GoToSocial limits the sign-up pending backlog to 20 accounts. Once there are 20 accounts pending in the backlog waiting to be handled by an admin or moderator, new sign-ups will not be accepted via the form.
|
||||
|
||||
By default, new sign-ups will also not be accepted via the form if 10 or more new account sign-ups have been approved in the last 24 hours, to avoid instances rapidly expanding beyond the capabilities of moderators.
|
||||
New sign-ups will also not be accepted via the form if 10 or more new account sign-ups have been approved in the last 24 hours, to avoid instances rapidly expanding beyond the capabilities of moderators.
|
||||
|
||||
In both cases, applicants will be shown an error message explaining why they could not submit the form, and inviting them to try again later.
|
||||
|
||||
The limit of sign-ups per day, and the backlog size, can be configured or disabled altogether with the variables `accounts-registration-daily-limit` and `accounts-registration-backlog-limit`. See the [accounts config section](../configuration/accounts.md) for more info.
|
||||
|
||||
To combat spam accounts, GoToSocial account sign-ups **always** require manual approval by an administrator, and applicants must **always** confirm their email address before they are able to log in and post.
|
||||
|
||||
## Sign-Up Via Invite
|
||||
|
|
|
|||
|
|
@ -1,43 +0,0 @@
|
|||
# Managing GtS on slow hardware
|
||||
|
||||
While GoToSocial runs great on lower-end hardware, some operations are not practical on it, especially
|
||||
instances with the database on slow storage (think anything that is not an SSD). This document
|
||||
offers some suggestions on how to work around common issues when running GtS on slow hardware.
|
||||
|
||||
## Running database migrations on a different machine
|
||||
|
||||
Sometimes a database migration will need to do operations that are taxing on the database's storage.
|
||||
These operations can take days if the database resides on a hard disk or SD card. If your
|
||||
database is on slow storage, it can save a lot of time to follow the following procedure:
|
||||
|
||||
!!! danger
|
||||
|
||||
It might seem tempting to keep GtS running while you run the migrations on another machine, but
|
||||
doing this will lead to all the posts that are received during the migration post disappearing
|
||||
once the migrated database is re-imported.
|
||||
|
||||
1. Shut down GtS
|
||||
2. Take a [backup](backup_and_restore.md#what-to-backup-database) of the database
|
||||
3. Import the database on faster hardware
|
||||
4. Run the GtS migration on the faster hardware
|
||||
5. Take a backup of the resultant database
|
||||
6. Import the resultant backup and overwrite the old database
|
||||
7. Start GtS with the new version
|
||||
|
||||
### Running GtS migrations separately
|
||||
|
||||
After you import the database on the faster hardware, you can run the migration without starting
|
||||
GtS by downloading the *target* GtS version from the [releases](https://codeberg.org/superseriousbusiness/gotosocial/releases) page.
|
||||
For instance, if you are running `v0.19.2` and you want to upgrade to `v0.20.0-rc1`, download the
|
||||
latter version. Once you have the binary, set it to executable by running `chmod u+x /path/to/gotosocial`. Afterwards, copy the configuration of the original server, and alter
|
||||
it with the location of the new database. We copy the configuration in case variables like
|
||||
the hostname is used in the migration, we want to keep that consistent.
|
||||
Once everything is in place, you can run the migration like this:
|
||||
|
||||
```sh
|
||||
$ /path/to/gotosocial --config-path /path/to/config migrations run
|
||||
```
|
||||
|
||||
This will run all the migrations, just like GtS would if it was started normally. Once this is done
|
||||
you can copy the result to the original instance and start the new GtS version there as well, which
|
||||
will see that everything is migrated and that there's nothing to do except run as expected.
|
||||
|
|
@ -15,10 +15,6 @@ However! To enable folks to run **experimental, unsupported deployments of GoToS
|
|||
|
||||
A GoToSocial binary built with `nowasm` will use the [modernc version of SQLite](https://pkg.go.dev/modernc.org/sqlite) instead of the WASM one, and will use on-system `ffmpeg` and `ffprobe` binaries for media processing.
|
||||
|
||||
!!! tip
|
||||
To test if your system is compatible with the standard builds, you can use this command:
|
||||
`if grep -qE '^flags.* (sse4|LSE)' /proc/cpuinfo; then echo "Your system is supporting GTS!"; else echo "Your system is not supporting GTS, you'll have to use the 'nowasm' builds :("; fi`
|
||||
|
||||
To build GoToSocial with the `nowasm` tag, you can pass the tag into our convenience `build.sh` script like so:
|
||||
|
||||
```bash
|
||||
|
|
|
|||
|
|
@ -1,89 +1,32 @@
|
|||
# Metrics
|
||||
|
||||
GoToSocial uses the [OpenTelemetry][otel] Go SDK to enable instance admins to expose runtime metrics in the Prometheus metrics format.
|
||||
GoToSocial comes with [OpenTelemetry][otel] based metrics. The metrics are exposed using the [Prometheus exposition format][prom] on the `/metrics` path. The configuration settings are documented in the [Observability configuration reference][obs].
|
||||
|
||||
Currently, the following metrics are collected:
|
||||
Currently the following metrics are collected:
|
||||
|
||||
* Go performance and runtime metrics
|
||||
* Gin (HTTP server) metrics
|
||||
* Gin (HTTP) metrics
|
||||
* Bun (database) metrics
|
||||
|
||||
## Enabling metrics
|
||||
|
||||
To enable metrics, first set the `metrics-enabled` configuration value to `true` in your config.yaml file:
|
||||
Metrics can be enable with the following configuration:
|
||||
|
||||
```yaml
|
||||
metrics-enabled: true
|
||||
```
|
||||
|
||||
Then, you will need to set some additional environment variables on the GoToSocial process in order to configure OpenTelemetry to expose metrics in the Prometheus format:
|
||||
|
||||
```env
|
||||
OTEL_METRICS_PRODUCERS=prometheus
|
||||
OTEL_METRICS_EXPORTER=prometheus
|
||||
```
|
||||
|
||||
By default, this configuration will instantiate an additional HTTP server running alongside the standard GoToSocial HTTP server, which exposes a Prometheus metrics endpoint at `localhost:9464/metrics`.
|
||||
|
||||
!!! tip
|
||||
If you are running GoToSocial using the [example systemd service definition](../../example/gotosocial.service), you can easily set these environment variables by uncommenting the relevant two lines in that file, and reloading + restarting the service.
|
||||
|
||||
If you wish, you can further customize this metrics HTTP server by using the following environment variables to change the host and port:
|
||||
|
||||
```env
|
||||
OTEL_EXPORTER_PROMETHEUS_HOST=example.org
|
||||
OTEL_EXPORTER_PROMETHEUS_PORT=9999
|
||||
```
|
||||
|
||||
## Serving metrics to the outside world
|
||||
|
||||
If you have deployed GoToSocial in a "bare-metal" fashion without a reverse proxy, you can expose the metrics endpoint to the outside world by setting `OTEL_EXPORTER_PROMETHEUS_HOST` to your host value. For example, if your GtS instance `host` configuration value is set to `example.org`, you should set `OTEL_EXPORTER_PROMETHEUS_HOST=example.org`. You should then be able to access your metrics at `http://example.org:9464/metrics`. GoToSocial running in this fashion will not serve LetsEncrypt certificates at the metrics endpoint, so you will be limited to using HTTP rather than HTTPS.
|
||||
|
||||
If you are using a reverse proxy like Nginx, you can expose the metrics endpoint to the outside world with HTTPS certificates, by putting an additional location stanza in your Nginx configuration above the catch-all `location /` stanza:
|
||||
|
||||
```nginx
|
||||
location /metrics {
|
||||
proxy_pass http://127.0.0.1:9464;
|
||||
}
|
||||
```
|
||||
|
||||
This will instruct Nginx to forward requests to `example.org/metrics` to the separate Prometheus server running on port 9464.
|
||||
Though metrics do not contain anything privacy sensitive, you may not want to allow just anyone to view and scrape operational metrics of your instance.
|
||||
|
||||
## Enabling basic authentication
|
||||
|
||||
Although there is no sensitive data contained in the OTEL runtime statistics exported by Prometheus, you may nevertheless wish to gate access to the `/metrics` endpoint behind some kind of authentication, to prevent every Tom, Dick, and Harry from looking at your runtime stats.
|
||||
You can enable basic authentication for the metrics endpoint. On the GoToSocial, side you'll need the following configuration:
|
||||
|
||||
You can do this by configuring your reverse proxy to require basic authentication for access to `/metrics`.
|
||||
|
||||
In Nginx, for example, you could do this by creating an `htpasswd` file alongside your site in the `sites-available` directory of Nginx, and instructing Nginx to use that file to gate access.
|
||||
|
||||
Assuming you followed the [guide for setting up Nginx as your reverse proxy](../getting_started/reverse_proxy/nginx.md), you will already have a file for your Nginx service definition at `/etc/nginx/sites-available/example.org`, where `example.org` is the hostname of your instance.
|
||||
|
||||
You can create an `htpasswd` file alongside this file using the following command:
|
||||
|
||||
```bash
|
||||
htpasswd -c /etc/nginx/sites-available/example.org.htpasswd username
|
||||
```yaml
|
||||
metrics-auth-enabled: true
|
||||
metrics-auth-username: some_username
|
||||
metrics-auth-password: some_password
|
||||
```
|
||||
|
||||
In the command, be sure to replace `example.org` with your hostname, and `username` with whatever username you want to use.
|
||||
|
||||
Now, edit `/etc/nginx/sites-available/example.org` and update your `/metrics` stanza to use the `httpasswd` file. After editing it should look something like this:
|
||||
|
||||
```nginx
|
||||
location /metrics {
|
||||
proxy_pass http://127.0.0.1:9464;
|
||||
auth_basic "Metrics";
|
||||
auth_basic_user_file /etc/nginx/sites-available/example.org.htpasswd;
|
||||
}
|
||||
```
|
||||
|
||||
Again, replace `example.org` in that snippet with your instance hostname.
|
||||
|
||||
When you're finished editing, reload + restart Nginx, and you should see a basic authentication prompt when visiting the `/metrics` endpoint of your instance in your browser.
|
||||
|
||||
## Prometheus scrape configuration
|
||||
|
||||
You can scrape your `/metrics` endpoint with a Prometheus instance using the following configuration in your `scrape_configs`:
|
||||
You can scrape that endpoint with a Prometheus instance using the following configuration in your `scrape_configs`:
|
||||
|
||||
```yaml
|
||||
- job_name: gotosocial
|
||||
|
|
@ -97,12 +40,18 @@ You can scrape your `/metrics` endpoint with a Prometheus instance using the fol
|
|||
- example.org
|
||||
```
|
||||
|
||||
Change `example.org` to your hostname in the above snippet. If you are not using HTTPS, change the `scheme` value to `http`. If you are not using basic authentication, you can remove the `basic_auth` section. If you are not using a reverse proxy, and metrics are exposed on port 9464, add the port to the host (eg., `example.org` -> `example.org:9464`).
|
||||
## Blocking external scraping
|
||||
|
||||
## Viewing metrics on Grafana
|
||||
When running with a reverse proxy you can use it to block external access to metrics. You can use this approach if your Prometheus scraper runs on the same machine as your GoToSocial instance and can thus access it internally.
|
||||
|
||||
Instructions on how to set up Grafana are beyond the scope of this document. However, once you have set up a Grafana to pull from your Prometheus instance, you can import the [example Grafana dashboard](https://codeberg.org/superseriousbusiness/gotosocial/raw/branch/main/example/metrics/gotosocial_grafana_dashboard.json) into your Grafana frontend to easily view GoToSocial Go runtime and HTTP metrics.
|
||||
For example with nginx, block the `/metrics` endpoint by returning a 404:
|
||||
|
||||
```nginx
|
||||
location /metrics {
|
||||
return 404;
|
||||
}
|
||||
```
|
||||
|
||||
[otel]: https://opentelemetry.io/
|
||||
[prom]: https://prometheus.io/docs/instrumenting/exposition_formats/
|
||||
[obs]: ../configuration/observability_and_metrics.md
|
||||
[obs]: ../configuration/observability.md
|
||||
|
|
@ -18,7 +18,7 @@ Different distributions have different sandboxing mechanisms they prefer and sup
|
|||
We ship an example AppArmor policy for GoToSocial, which you can retrieve and install as follows:
|
||||
|
||||
```sh
|
||||
$ curl -LO 'https://codeberg.org/superseriousbusiness/gotosocial/raw/main/example/apparmor/gotosocial'
|
||||
$ curl -LO 'https://github.com/superseriousbusiness/gotosocial/raw/main/example/apparmor/gotosocial'
|
||||
$ sudo install -o root -g root gotosocial /etc/apparmor.d/gotosocial
|
||||
$ sudo apparmor_parser -Kr /etc/apparmor.d/gotosocial
|
||||
```
|
||||
|
|
|
|||
|
|
@ -32,4 +32,4 @@ You'll need to update the following settings:
|
|||
* `db-sqlite-journal-mode`
|
||||
* `db-sqlite-synchronous`
|
||||
|
||||
We don't provide any recommendations as this will vary based on the solution you're using. See [this issue](https://codeberg.org/superseriousbusiness/gotosocial/issues/3360#issuecomment-2380332027) for what you could potentially set those values to.
|
||||
We don't provide any recommendations as this will vary based on the solution you're using. See [this issue](https://github.com/superseriousbusiness/gotosocial/issues/3360#issuecomment-2380332027) for what you could potentially set those values to.
|
||||
|
|
|
|||
|
|
@ -1,20 +1,25 @@
|
|||
# Tracing
|
||||
|
||||
GoToSocial comes with [OpenTelemetry][otel] based tracing built-in. It's not wired through every function, but our HTTP handlers and database library will create spans that may help you debug issues.
|
||||
|
||||
## Enabling tracing
|
||||
|
||||
To enable tracing on your instance, you must set `tracing-enabled` to `true` in your config.yaml file. Then, you must set the environment variable `OTEL_TRACES_EXPORTER` to your desired tracing format. A list of available options is available [here](https://opentelemetry.io/docs/languages/sdk-configuration/general/#otel_traces_exporter). Once you have changed your config and set the environment variable, restart your instance.
|
||||
|
||||
If necessary, you can do further configuration of tracing using the other environment variables listed [here](https://opentelemetry.io/docs/languages/sdk-configuration/general/).
|
||||
|
||||
## Ingesting traces
|
||||
GoToSocial comes with [OpenTelemetry][otel] based tracing built-in. It's not wired through every function, but our HTTP handlers and database library will create spans. How to configure tracing is explained in the [Observability configuration reference][obs].
|
||||
|
||||
In order to receive the traces, you need something to ingest them and then visualise them. There are many options available including self-hosted and commercial options.
|
||||
|
||||
In [`example/tracing`][ext] we provide an example of how to do this using [Grafana Tempo][tempo] to ingest the spans and [Grafana][grafana] to explore them. You can use the files with `docker-compose up -d` to get Tempo and Grafana running.
|
||||
We provide an example of how to do this using [Grafana Tempo][tempo] to ingest the spans and [Grafana][grafana] to explore them. Please beware that the configuration we provide is not suitable for a production setup. It can be used safely for local development and can provide a good starting point for setting up your own tracing infrastructure.
|
||||
|
||||
Please be aware that while the example configuration we provide can be used safely for local development and can provide a good starting point for setting up your own tracing infrastructure, it is not suitable for a so-called "production" setup.
|
||||
You'll need the files in [`example/tracing`][ext]. Once you have those you can run `docker-compose up -d` to get Tempo and Grafana running. With both services running, you can add the following to your GoToSocial configuration and restart your instance:
|
||||
|
||||
```yaml
|
||||
tracing-enabled: true
|
||||
tracing-transport: "grpc"
|
||||
tracing-endpoint: "localhost:4317"
|
||||
tracing-insecure-transport: true
|
||||
```
|
||||
|
||||
[otel]: https://opentelemetry.io/
|
||||
[obs]: ../configuration/observability.md
|
||||
[tempo]: https://grafana.com/oss/tempo/
|
||||
[grafana]: https://grafana.com/oss/grafana/
|
||||
[ext]: https://github.com/superseriousbusiness/gotosocial/tree/main/example/tracing
|
||||
|
||||
## Querying and visualising traces
|
||||
|
||||
|
|
@ -22,23 +27,18 @@ Once you execute a few queries against your instance, you'll be able to find the
|
|||
|
||||
Using TraceQL, a simple query to find all traces related to requests to `/api/v1/instance` would look like this:
|
||||
|
||||
```traceql
|
||||
```
|
||||
{.http.route = "/api/v1/instance"}
|
||||
```
|
||||
|
||||
If you wanted to see all GoToSocial traces, you could instead run:
|
||||
|
||||
```traceql
|
||||
```
|
||||
{.service.name = "GoToSocial"}
|
||||
```
|
||||
|
||||
Once you select a trace, a second panel will open up visualising the span. You can drill down from there, by clicking into every sub-span to see what it was doing.
|
||||
|
||||

|
||||

|
||||
|
||||
[traceql]: https://grafana.com/docs/tempo/latest/traceql/
|
||||
[otel]: https://opentelemetry.io/
|
||||
[obs]: ../configuration/observability_and_metrics.md
|
||||
[tempo]: https://grafana.com/oss/tempo/
|
||||
[grafana]: https://grafana.com/oss/grafana/
|
||||
[ext]: https://codeberg.org/superseriousbusiness/gotosocial/src/branch/main/example/tracing
|
||||
|
|
|
|||
|
|
@ -2,15 +2,13 @@
|
|||
|
||||
Using the client API requires authentication. This page documents the general flow for retrieving an authentication token with examples for doing this on the CLI using `curl`.
|
||||
|
||||
!!! tip
|
||||
If you want to get an API access token via the settings panel instead, without having to use the command line, see the [Application documentation](https://docs.gotosocial.org/en/latest/user_guide/settings/#applications).
|
||||
|
||||
## Create a new application
|
||||
|
||||
We need to register a new application, which we can then use to request an OAuth token. This is done by making a `POST` request to the `/api/v1/apps` endpoint. Replace `your_app_name` in the command below with the name you want to use for your application:
|
||||
|
||||
```bash
|
||||
curl \
|
||||
-X POST \
|
||||
-H 'Content-Type:application/json' \
|
||||
-d '{
|
||||
"client_name": "your_app_name",
|
||||
|
|
@ -22,15 +20,18 @@ curl \
|
|||
|
||||
The string `urn:ietf:wg:oauth:2.0:oob` is an indication of what is known as out-of-band authentication - a technique used in multi-factor authentication to reduce the number of ways that a bad actor can intrude on the authentication process. In this instance, it allows us to view and manually copy the tokens created to use further in this process.
|
||||
|
||||
!!! tip "Scopes"
|
||||
It is always good practice to grant your application the lowest tier permissions it needs to do its job. e.g. If your application won't be making posts, use `scope=read` or even a subscope of that.
|
||||
Note that `scopes` can be any space-separated combination of:
|
||||
|
||||
In this spirit, "read" is used in the example above, which means that the application will be restricted to only being able to do "read" actions.
|
||||
|
||||
For a list of available scopes, see [the swagger docs](https://docs.gotosocial.org/en/latest/api/swagger/).
|
||||
- `read`
|
||||
- `write`
|
||||
- `admin`
|
||||
|
||||
!!! warning
|
||||
GoToSocial did not support scoped authorization tokens before version 0.19.0, so if you are using a version of GoToSocial below that, then any token you obtain in this process will be able to perform all actions on your behalf, including admin actions if your account has admin permissions.
|
||||
GoToSocial does not currently support scoped authorization tokens, so any token you obtain in this process will be able to perform all actions on your behalf, including admin actions if your account has admin permissions. Nevertheless, it is always good practice to grant your application the lowest tier permissions it needs to do its job. e.g. If your application won't be making posts, use scope=read.
|
||||
|
||||
In this spirit, "read" is used in the example above, which means that in the future when scoped tokens are supported, the application will be restricted to only being able to do "read" actions.
|
||||
|
||||
You can read more about additional planned OAuth security features [right here](https://github.com/superseriousbusiness/gotosocial/issues/2232).
|
||||
|
||||
A successful call returns a response with a `client_id` and `client_secret`, which we are going need to use in the rest of the process. It looks something like this:
|
||||
|
||||
|
|
@ -88,6 +89,7 @@ You can do this with another `POST` request that looks like the following:
|
|||
|
||||
```bash
|
||||
curl \
|
||||
-X POST \
|
||||
-H 'Content-Type: application/json' \
|
||||
-d '{
|
||||
"redirect_uri": "urn:ietf:wg:oauth:2.0:oob",
|
||||
|
|
@ -126,6 +128,7 @@ See this example:
|
|||
|
||||
```bash
|
||||
curl \
|
||||
-H 'Content-Type: application/json' \
|
||||
-H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
|
||||
'https://example.org/api/v1/accounts/verify_credentials'
|
||||
```
|
||||
|
|
@ -139,6 +142,7 @@ For example, you can issue another `GET` request to the API using the same acces
|
|||
|
||||
```bash
|
||||
curl \
|
||||
-H 'Content-Type: application/json' \
|
||||
-H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
|
||||
'https://example.org/api/v1/notifications'
|
||||
```
|
||||
|
|
|
|||
|
|
@ -24,11 +24,11 @@ In case the rate limit is exceeded, an [HTTP 429 Too Many Requests](https://deve
|
|||
|
||||
### My rate limit keeps being exceeded! Why?
|
||||
|
||||
If you find that your rate limit is regularly being exceeded (both for yourself and other callers) during normal use of your instance, it may be that GoToSocial can't tell the clients apart by IP address. You can investigate this by viewing the logs of your instance. If (almost) all logged client IP addresses appear to be the same IP address (something like `172.x.x.x`), then the rate limiting will cause problems.
|
||||
If you find that your rate limit is regularly being exceeded (both for yourself and other callers) during normal use of your instance, it may be that GoToSocial can't tell the clients apart by IP address. You can investigate this by viewing the logs of your instance. If (almost) all logged IP addresses appear to be the same IP address (something like `172.x.x.x`), then the rate limiting will cause problems.
|
||||
|
||||
This happens when your server is running inside NAT (port forwarding), or behind an HTTP proxy without the correct configuration, causing your instance to see all incoming IP addresses as the same address: namely, the IP address of your reverse proxy or gateway. This means that all incoming requests are *sharing the same rate limit*, rather than being split correctly per IP.
|
||||
|
||||
If you are using an HTTP proxy then it's likely that your `trusted-proxies` is not correctly configured. See the [trusted-proxies](../configuration/trusted_proxies.md) documentation for more info on how to resolve this.
|
||||
If you are using an HTTP proxy then it's likely that your `trusted-proxies` is not correctly configured. If this is the case, try adding the IP address of your reverse proxy to the list of `trusted-proxies`, and restarting your instance.
|
||||
|
||||
If you don't have an HTTP proxy, then it's likely caused by NAT. In this case you should disable rate limiting altogether.
|
||||
|
||||
|
|
|
|||
|
|
@ -14,8 +14,8 @@ Most of the GoToSocial API endpoints require a user-level OAuth token. For a gui
|
|||
|
||||
See the following issues for more context:
|
||||
|
||||
- [#1958](https://codeberg.org/superseriousbusiness/gotosocial/issues/1958)
|
||||
- [#1944](https://codeberg.org/superseriousbusiness/gotosocial/issues/1944)
|
||||
- [#2641](https://codeberg.org/superseriousbusiness/gotosocial/issues/2641)
|
||||
- [#1958](https://github.com/superseriousbusiness/gotosocial/issues/1958)
|
||||
- [#1944](https://github.com/superseriousbusiness/gotosocial/issues/1944)
|
||||
- [#2641](https://github.com/superseriousbusiness/gotosocial/issues/2641)
|
||||
|
||||
<swagger-ui src="swagger.yaml"/>
|
||||
|
|
|
|||
|
Before Width: | Height: | Size: 102 KiB After Width: | Height: | Size: 102 KiB |
|
Before Width: | Height: | Size: 90 KiB After Width: | Height: | Size: 90 KiB |
|
Before Width: | Height: | Size: 125 KiB After Width: | Height: | Size: 125 KiB |
BIN
docs/assets/admin-settings-federation.png
Normal file
|
After Width: | Height: | Size: 95 KiB |
BIN
docs/assets/admin-settings-instance.png
Normal file
|
After Width: | Height: | Size: 200 KiB |
|
Before Width: | Height: | Size: 224 KiB After Width: | Height: | Size: 224 KiB |
|
Before Width: | Height: | Size: 109 KiB After Width: | Height: | Size: 109 KiB |
|
Before Width: | Height: | Size: 14 KiB After Width: | Height: | Size: 14 KiB |
|
Before Width: | Height: | Size: 485 KiB After Width: | Height: | Size: 485 KiB |
|
Before Width: | Height: | Size: 492 KiB After Width: | Height: | Size: 492 KiB |
|
Before Width: | Height: | Size: 488 KiB After Width: | Height: | Size: 488 KiB |
|
Before Width: | Height: | Size: 23 KiB After Width: | Height: | Size: 23 KiB |
|
Before Width: | Height: | Size: 59 KiB After Width: | Height: | Size: 59 KiB |
|
Before Width: | Height: | Size: 90 KiB After Width: | Height: | Size: 90 KiB |
|
Before Width: | Height: | Size: 131 KiB After Width: | Height: | Size: 131 KiB |
|
Before Width: | Height: | Size: 87 KiB After Width: | Height: | Size: 87 KiB |
|
Before Width: | Height: | Size: 227 KiB After Width: | Height: | Size: 227 KiB |
|
Before Width: | Height: | Size: 133 KiB After Width: | Height: | Size: 133 KiB |
|
Before Width: | Height: | Size: 633 KiB After Width: | Height: | Size: 633 KiB |
|
Before Width: | Height: | Size: 879 KiB After Width: | Height: | Size: 879 KiB |
|
Before Width: | Height: | Size: 1.1 KiB After Width: | Height: | Size: 1.1 KiB |
|
Before Width: | Height: | Size: 76 KiB After Width: | Height: | Size: 76 KiB |
|
Before Width: | Height: | Size: 110 KiB After Width: | Height: | Size: 110 KiB |
|
Before Width: | Height: | Size: 72 KiB After Width: | Height: | Size: 72 KiB |
|
Before Width: | Height: | Size: 17 KiB After Width: | Height: | Size: 17 KiB |
|
Before Width: | Height: | Size: 650 KiB After Width: | Height: | Size: 650 KiB |