Skip to content

Commit

Permalink
show how to run
Browse files Browse the repository at this point in the history
  • Loading branch information
smathermather authored Nov 9, 2023
1 parent d7acd25 commit 16149f0
Showing 1 changed file with 20 additions and 1 deletion.
21 changes: 20 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,13 @@ If you need to test changes as a docker image, you can build easily as follows:
docker build -t my_nodeodm_image --no-cache .
```

Run as follows:

```
docker run -p 3000:3000 my_nodeodm_image &
```


### Testing alternative ODM images through NodeODM

In order to test alternative ODM docker images in NodeODM, you will need to change the dockerfile for NodeODM to point to your ODM image. For example if you built an alternate ODM image as follows:
Expand All @@ -46,7 +53,7 @@ In order to test alternative ODM docker images in NodeODM, you will need to chan
docker build -t my_odm_image --no-cache .
```

Then you'll modify NodeODM's Dockerfile to point to the new ODM image in the first line:
Then modify NodeODM's Dockerfile to point to the new ODM image in the first line:

```
FROM my_odm_image
Expand All @@ -56,6 +63,18 @@ EXPOSE 3000
...
```

Then build the NodeODM image:

```
docker build -t my_nodeodm_image --no-cache .
```

Finally run as follows:

```
docker run -p 3000:3000 my_nodeodm_image &
```

### Running rootless

* A rootless alternative to Docker is using [Apptainer](https://apptainer.org/). In order to run NodeODM together with ClusterODM in rootless environments, for example on HPC, we need a rootless alternative to Docker, and that's where Apptainer comes in to play. From the Linux command line, cd into the NodeODM folder and run the following commands to host a NodeODM instance:
Expand Down

0 comments on commit 16149f0

Please sign in to comment.