arch/tclip
1
0
Fork 0
Code Pull requests Actions Packages Activity

README: update directions for deployment

Browse source 
Signed-off-by: Xe Iaso <xe@tailscale.com>
This commit is contained in:
Xe Iaso 2023-01-17 14:19:52 +00:00
parent 2b46d26c2d
commit 0e1b5dc2e6
1 changed files with 25 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

36
README.md
View file

@ -90,6 +90,10 @@ $ flyctl deploy
You should be able to open the app at [http://paste](http://paste) and You should be able to open the app at [http://paste](http://paste) and
paste to your heart's content. paste to your heart's content.
#### Updating
Run `flyctl deploy` to update the service.
### Normal Docker ### Normal Docker
To run this service in Docker, run the following command: To run this service in Docker, run the following command:
@ -105,6 +109,8 @@ docker run \
ghcr.io/tailscale-dev/tclip:main ghcr.io/tailscale-dev/tclip:main
``` ```
#### Updating
Every so often you should pull a new version of tclip and Every so often you should pull a new version of tclip and
recreate the container: recreate the container:
@ -129,14 +135,14 @@ install tclip on any Linux distribution with systemd (and the
on Ubuntu). This lets you view tclip logs with `journalctl` and on Ubuntu). This lets you view tclip logs with `journalctl` and
manage it like any other systemd service. manage it like any other systemd service.
Download the portable service image yada yada TODO(Xe) fix this You can download the portable service image from CI by looking at the
[recently finished
```console builds](https://github.com/tailscale-dev/tclip/actions?query=is%3Asuccess+branch%3Amain),
TODO(Xe): this clicking on the most recent one, and downloading the
``` `portable-service` artifact. This will get you a zipfile that contains
a single `.raw` file. Copy this `.raw` file to `/var/lib/portable` on
Then run `portablectl list` to get a list of available portable your target server. Then run `portablectl list` to get a list of
services: available portable services:
```console ```console
$ portablectl list $ portablectl list
@ -153,12 +159,13 @@ $ sudo portablectl attach tclip_0.1.0-20230116
``` ```
Next, create the folder `/etc/systemd/system/tclip.service.d` Next, create the folder `/etc/systemd/system/tclip.service.d`
and create the file `10-ts-auth-key.conf` in it with the following contents: and create the file `10-ts-auth-key.conf` in it with the following
contents (be sure to replace `<key>` with your tailnet authkey):
```systemd ```systemd
# /etc/systemd/system/tclip.service.d/10-ts-auth-key.conf # /etc/systemd/system/tclip.service.d/10-ts-authkey.conf
[Service] [Service]
Environment=TS_AUTH_KEY=<key> Environment=TS_AUTHKEY=<key>
``` ```
Finally, enable `tclip.service` and start it with `systemctl Finally, enable `tclip.service` and start it with `systemctl
@ -172,6 +179,13 @@ Wait a moment for it to connect to Tailscale and then check on it with
`tailscale status`. Your new node named `paste` should show up in your `tailscale status`. Your new node named `paste` should show up in your
tailnet. tailnet.
#### Updating
To update tclip, first detach the portable service using `portablectl
detach` after finding the list with `portablectl list`. Then delete
the correlating `.raw` file in `/var/lib/portables`. Download a new
one in its place and re-attach and re-enable the service.
#### Backups #### Backups
Add the path `/var/lib/private/tclip` to your backup program of Add the path `/var/lib/private/tclip` to your backup program of