julien.rbrt.fr
forked from
tangled.org/core
Monorepo for Tangled — https://tangled.org
1# Migrations
2
3This document is laid out in reverse-chronological order.
4Newer migration guides are listed first, and older guides
5are further down the page.
6
7## Upgrading from v1.8.x
8
9After v1.8.2, the HTTP API for knot and spindles have been
10deprecated and replaced with XRPC. Repositories on outdated
11knots will not be viewable from the appview. Upgrading is
12straightforward however.
13
14For knots:
15
16- Upgrade to latest tag (v1.9.0 or above)
17- Head to the [knot dashboard](https://tangled.org/settings/knots) and
18 hit the "retry" button to verify your knot
19
20For spindles:
21
22- Upgrade to latest tag (v1.9.0 or above)
23- Head to the [spindle
24 dashboard](https://tangled.org/settings/spindles) and hit the
25 "retry" button to verify your spindle
26
27## Upgrading from v1.7.x
28
29After v1.7.0, knot secrets have been deprecated. You no
30longer need a secret from the appview to run a knot. All
31authorized commands to knots are managed via [Inter-Service
32Authentication](https://atproto.com/specs/xrpc#inter-service-authentication-jwt).
33Knots will be read-only until upgraded.
34
35Upgrading is quite easy, in essence:
36
37- `KNOT_SERVER_SECRET` is no more, you can remove this
38 environment variable entirely
39- `KNOT_SERVER_OWNER` is now required on boot, set this to
40 your DID. You can find your DID in the
41 [settings](https://tangled.org/settings) page.
42- Restart your knot once you have replaced the environment
43 variable
44- Head to the [knot dashboard](https://tangled.org/settings/knots) and
45 hit the "retry" button to verify your knot. This simply
46 writes a `sh.tangled.knot` record to your PDS.
47
48If you use the nix module, simply bump the flake to the
49latest revision, and change your config block like so:
50
51```diff
52 services.tangled.knot = {
53 enable = true;
54 server = {
55- secretFile = /path/to/secret;
56+ owner = "did:plc:foo";
57 };
58 };
59```