summaryrefslogtreecommitdiff
path: root/docs/getting_started
diff options
context:
space:
mode:
authorLibravatar tobi <31960611+tsmethurst@users.noreply.github.com>2023-08-15 18:48:17 +0200
committerLibravatar GitHub <noreply@github.com>2023-08-15 18:48:17 +0200
commit42bb352d5398ca681543362ee9bc0a69a9ba04fe (patch)
treeb16736e2315609c35004fc64f3b72e182fd5f6a9 /docs/getting_started
parent[chore] ensure worker contexts have request ID (#2120) (diff)
downloadgotosocial-42bb352d5398ca681543362ee9bc0a69a9ba04fe.tar.xz
[feature] Add snapshot binary builds + uploads (#2119)
* [feature] Add snapshot binary builds + uploads * Update docs to include info on snapshot builds * review comments * little tweaks
Diffstat (limited to 'docs/getting_started')
-rw-r--r--docs/getting_started/installation/metal.md3
-rw-r--r--docs/getting_started/releases.md7
2 files changed, 10 insertions, 0 deletions
diff --git a/docs/getting_started/installation/metal.md b/docs/getting_started/installation/metal.md
index b7afa309c..bac4c2f26 100644
--- a/docs/getting_started/installation/metal.md
+++ b/docs/getting_started/installation/metal.md
@@ -38,6 +38,9 @@ tar -xzf gotosocial_0.5.2_linux_amd64.tar.gz
This will put the `gotosocial` binary in your current directory, in addition to the `web` folder, which contains assets for the web frontend, and an `example` folder, which contains a sample configuration file.
+!!! danger
+ If you prefer to use a snapshot build of GoToSocial based on whatever code is currently on main, you can download recent binary .tar.gz files from https://minio.s3.superseriousbusiness.org/browser/gotosocial-snapshots (keyed by commit hash). Only do this if you know what you're doing, otherwise just take a stable release.
+
## Edit Configuration File
Copy the configuration file from the example folder into your current directory:
diff --git a/docs/getting_started/releases.md b/docs/getting_started/releases.md
index 14b6e4a58..5f566acf0 100644
--- a/docs/getting_started/releases.md
+++ b/docs/getting_started/releases.md
@@ -3,6 +3,7 @@
GoToSocial can be installed in a number of different ways. We publish official binary releases as well as container images. A number of third-party packages are maintained by different distributions and some people have created additional deployment tooling to make it easy to deploy GoToSocial yourself.
## Binary releases
+
We publish binary builds for Linux to [our GitHub project](https://github.com/superseriousbusiness/gotosocial/releases):
* 32-bit Intel/AMD (i386/x86)
@@ -20,6 +21,12 @@ We also publish container images [on the Docker Hub](https://hub.docker.com/r/su
Containers are released for the same Linux platforms as our binary releases, with the exception of 32-bit Intel/AMD.
+## Snapshots
+
+We publish snapshot binary builds and Docker images of whatever is currently on main.
+
+We always recommend using a stable release instead, but if you want to live on the edge (at your own risk!) then see the [snapshots](https://github.com/superseriousbusiness/gotosocial#snapshots) section on our GitHub repo for more information.
+
## Third-party
Some folks have created distribution packages for GoToSocial or additional tooling to aid in installing GoToSocial.