Skip to content

Commit adc5024

Browse files
committed
Update README.md's usage instructions for forklift v0.7
1 parent 04dcca1 commit adc5024

File tree

1 file changed

+28
-12
lines changed

1 file changed

+28
-12
lines changed

README.md

Lines changed: 28 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -21,29 +21,29 @@ that currently `forklift` is only tested for Linux computers.
2121

2222
### Deployment
2323

24-
You can clone the latest commit of this Forklift pallet to your computer, by
25-
using the `forklift` tool:
26-
```
27-
forklift plt clone github.com/PlanktoScope/pallet-segmenter@main
28-
```
24+
The instructions below assume that you are using a version of the `forklift` tool which is greater
25+
than or equal to v0.7.0 (but less than v0.8.0, which has not yet been released yet); other versions
26+
of the `forklift` tool may behave differently and thus may require different commands than what is
27+
described below:
28+
29+
#### First-time deployment
2930

30-
Then you can apply the cloned pallet on your computer using the following sequence of `forklift`
31-
CLI commands:
31+
You can clone, stage, and apply the latest commit of this Forklift pallet to your computer, by
32+
using the `forklift` tool:
3233
```
33-
forklift plt cache-repo
34-
sudo -E forklift plt apply
34+
sudo -E forklift pallet switch --apply github.com/PlanktoScope/pallet-segmenter@edge
3535
```
3636

3737
Warning: this will replace all Docker containers on your Docker host with the package deployments
3838
specified by this pallet and delete any Docker containers not specified by this pallet's package
3939
deployments.
4040

4141
If your user is [in the `docker` group](https://docs.docker.com/engine/install/linux-postinstall/#manage-docker-as-a-non-root-user)
42-
(so that you don't need to use `sudo` when running `docker`
43-
commands), then you can just run a single command instead of the three commands listed above:
42+
(so that you don't need to use `sudo` when running `docker` commands), then you can avoid using
43+
`sudo` with the `forklift` command:
4444

4545
```
46-
forklift plt switch github.com/PlanktoScope/pallet-segmenter@main
46+
forklift pallet switch --apply github.com/PlanktoScope/pallet-segmenter@edge
4747
```
4848

4949
Then you can access the Node-RED dashboard from your web browser at
@@ -58,6 +58,22 @@ The simplest way to add input datasets and download EcoTaxa export archives (wor
5858
with file permissions between your user account and the `root` user used for running the segmenter)
5959
will be to use the filebrowser in your web browser, at <http://localhost:9000>.
6060

61+
#### Subsequent deployment
62+
63+
Because the `forklift` tool uses [Docker Compose](https://docs.docker.com/compose/) to manage the
64+
Docker containers specified by this pallet, the containers will not run after the next time you
65+
restart your computer; you will need to run a command to start the containers again:
66+
67+
```
68+
sudo -E forklift stage apply
69+
```
70+
71+
Or if your user is in the `docker` group:
72+
73+
```
74+
forklift stage apply
75+
```
76+
6177
### Forking
6278

6379
To make your own copy of this repository for experimentation, you should fork this repository to a

0 commit comments

Comments
 (0)