Skip to content

Commit

Permalink
add instructions for docker image and docker desktop
Browse files Browse the repository at this point in the history
  • Loading branch information
Artur-man committed Jan 6, 2025
1 parent ff87979 commit 11a508f
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,18 @@ On **Fedora** you may need [`opencv-devel`](https://src.fedoraproject.org/rpms/o
yum install opencv-devel
```

## Docker Hub

You can also run VoltRon from a container already available in [Docker Hub](https://hub.docker.com/repository/docker/amanukyan1385/rstudio-voltron/general). The docker image is based on the [Rocker Project](https://rocker-project.org/) and can be run from the terminal like below:

```
docker run --rm -ti -e PASSWORD=<yourpassword> -p 8787:8787 amanukyan1385/rstudio-voltron:main
```

Then, start the RStudio session from the browser at `http://localhost:8787/` and enter `rstudio` as username and `<yourpassword>` as password.

See [here](https://github.com/BIMSBbioinfo/VoltRon/blob/main/inst/extdata/docker_desktop_instructions.md) for more instructions on how to run the container using [Docker Desktop](https://www.docker.com/products/docker-desktop/).

## Tutorials

Please see the [Explore](https://artur-man.github.io/VoltRon/tutorials.html) section in the VoltRon website for tutorials, example scripts and analysis found in the [preprint](https://www.biorxiv.org/content/10.1101/2023.12.15.571667v1). Tutorials include links for accessing necessary data to run scripts across all tutorials.
Expand Down
19 changes: 19 additions & 0 deletions inst/extdata/docker_desktop_instructions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
## Docker Desktop Instructions

1. Install Docker Desktop application from [https://www.docker.com/products/docker-desktop/](https://www.docker.com/products/docker-desktop/).

2. Pull the docker image from Docker Hub using the following command on the terminal:

```
docker pull amanukyan1385/rstudio-voltron:main
```

3. Open Docker Deskop app and go to `Images`

4. Find `amanukyan1385/rstudio-voltron:main` and click `Run` on the right.

5. Enter `8787` to Ports, `PASSWORD` to `Variable` and `yourpassword` (you can also give a custom password) to `Value` under Environment variables.

6. Click `Run`

7. Start the RStudio session from the browser at `http://localhost:8787/` and enter `rstudio` as username and `yourpassword` as password.

0 comments on commit 11a508f

Please sign in to comment.