forked from kapsner/docker_images
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
61 additions
and
61 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,61 +1,61 @@ | ||
| # R for datascience | ||
|
|
||
| <!-- badges: start --> | ||
| [](https://github.com/joundso/r_datascience/actions/workflows/generare-news.yml) | ||
| <!-- badges: end --> | ||
|
|
||
| This repo holds several files for my personal dockerized R environment including: | ||
|
|
||
| - **RStudio** ([Further information about RStudio](https://www.rstudio.com/)) | ||
| - **Shiny** ([Further information about Shiny](https://shiny.rstudio.com/)) | ||
| - Lots of usefull **pre-installed packages** (See a list of all installed packages [here](./Dockerfiles/rdsc_headless_j.dockerfile)) | ||
|
|
||
| It is roughly maintained and from time to time adjusted to my needs. | ||
|
|
||
| ## Usage | ||
|
|
||
| :bulb: If you want to mount folders from your host system to with the container, make sure they are correctly described in the [`docker-compose.yml`](./docker-compose.yml) file. If you don't want to mount anything, ignore this. | ||
|
|
||
| ```bash | ||
| git clone https://github.com/joundso/r_datascience.git Rdatascience | ||
| cd Rdatascience | ||
| docker-compose up -d | ||
| ``` | ||
|
|
||
| - On your host-machine, you can now open a webbrowser and go to page [`localhost:8787`](http://localhost:8787) to see RStudio server. Login with the user-password-combination specified in [`Dockerfiles/rdsc_base_j.dockerfile`](./Dockerfiles/rdsc_base_j.dockerfile) and start working. Default username is `user`, default password is `password`. | ||
|
|
||
| - When you deploy a shiny app, it will be accessible via [`localhost:3838`](http://localhost:3838). | ||
|
|
||
| - The [tag of the images](https://hub.docker.com/repository/docker/joundso/rdsc_rstudio_j/tags?page=1&ordering=last_updated) corresponds to the current R version. The R version in an image with the tag `4.3.0` is (of course) `R 4.3.0`. This also holds for sub-tags like `4.3.0-9001` where some changes in the image like different installed R packages might be the reason for the sub tag but the R version is still `4.3.0`. (Hint: All tags starting with `0.*.*` do not match this criteria. These images were built before this convention came up.) | ||
|
|
||
| - If you want to run two (or more) instances of the image, | ||
| 1. run `bash ./start_rdatascience.sh` to spin up the first container, | ||
| 2. open the [`.env`](./.env) file and uncomment the section for the ports for the second instance, | ||
| 3. comment out the ports for the first instance | ||
| 4. run `bash ./start_rdatascience.sh` again to spin up the second instance (run `docker ps -a` to see if both containers are running). | ||
|
|
||
| - To shut down the container(s), | ||
| 1. run `bash ./stop_rdatascience.sh` to spin down the container with the currently enabled ports in the `.env` file | ||
| 2. if multiple instances are running, open the [`.env`](./.env) file and uncomment the section for the ports of the second instance and comment out the ports of the last instance which is already shut down. Repeat these steps until all containers are shut down. | ||
| 3. Run `docker ps -a` to see if all containers are shut down correctly. | ||
|
|
||
| :bulb: If you want to use a custom docker-compose file, create it and assign the path to your custom dc-file in the [`.env`](./.env) file to the variable `CUSTOM_DOCKER_COMPOSE_FILE`. Then run the custom deplyment by running `bash ./start_rdatascience.sh`. | ||
|
|
||
| ## Build a new version of the image(s) | ||
|
|
||
| To build all images new, run | ||
|
|
||
| ```sh | ||
| ## Run the script to build the image(s): | ||
| sudo bash ./build_rdsc.sh | ||
| ``` | ||
|
|
||
| ## More Infos | ||
|
|
||
| - About RStudio Server: <https://www.rstudio.com/products/rstudio/download-server/> | ||
| - About Shiny: <https://www.rstudio.com/products/shiny/> | ||
| - RStudio and Shiny are trademarks of RStudio, Inc. | ||
|
|
||
| ## Contributions | ||
|
|
||
| Big thanks to [@kapsner](https://github.com/kapsner) for the inspiration of this fork: <https://github.com/kapsner/docker_images>! | ||
| # R for datascience | ||
|
|
||
| <!-- badges: start --> | ||
| [](https://github.com/joundso/r_datascience/blob/master/CHANGELOG.md) | ||
| <!-- badges: end --> | ||
|
|
||
| This repo holds several files for my personal dockerized R environment including: | ||
|
|
||
| - **RStudio** ([Further information about RStudio](https://www.rstudio.com/)) | ||
| - **Shiny** ([Further information about Shiny](https://shiny.rstudio.com/)) | ||
| - Lots of usefull **pre-installed packages** (See a list of all installed packages [here](./Dockerfiles/rdsc_headless_j.dockerfile)) | ||
|
|
||
| It is roughly maintained and from time to time adjusted to my needs. | ||
|
|
||
| ## Usage | ||
|
|
||
| :bulb: If you want to mount folders from your host system to with the container, make sure they are correctly described in the [`docker-compose.yml`](./docker-compose.yml) file. If you don't want to mount anything, ignore this. | ||
|
|
||
| ```bash | ||
| git clone https://github.com/joundso/r_datascience.git Rdatascience | ||
| cd Rdatascience | ||
| docker-compose up -d | ||
| ``` | ||
|
|
||
| - On your host-machine, you can now open a webbrowser and go to page [`localhost:8787`](http://localhost:8787) to see RStudio server. Login with the user-password-combination specified in [`Dockerfiles/rdsc_base_j.dockerfile`](./Dockerfiles/rdsc_base_j.dockerfile) and start working. Default username is `user`, default password is `password`. | ||
|
|
||
| - When you deploy a shiny app, it will be accessible via [`localhost:3838`](http://localhost:3838). | ||
|
|
||
| - The [tag of the images](https://hub.docker.com/repository/docker/joundso/rdsc_rstudio_j/tags?page=1&ordering=last_updated) corresponds to the current R version. The R version in an image with the tag `4.3.0` is (of course) `R 4.3.0`. This also holds for sub-tags like `4.3.0-9001` where some changes in the image like different installed R packages might be the reason for the sub tag but the R version is still `4.3.0`. (Hint: All tags starting with `0.*.*` do not match this criteria. These images were built before this convention came up.) | ||
|
|
||
| - If you want to run two (or more) instances of the image, | ||
| 1. run `bash ./start_rdatascience.sh` to spin up the first container, | ||
| 2. open the [`.env`](./.env) file and uncomment the section for the ports for the second instance, | ||
| 3. comment out the ports for the first instance | ||
| 4. run `bash ./start_rdatascience.sh` again to spin up the second instance (run `docker ps -a` to see if both containers are running). | ||
|
|
||
| - To shut down the container(s), | ||
| 1. run `bash ./stop_rdatascience.sh` to spin down the container with the currently enabled ports in the `.env` file | ||
| 2. if multiple instances are running, open the [`.env`](./.env) file and uncomment the section for the ports of the second instance and comment out the ports of the last instance which is already shut down. Repeat these steps until all containers are shut down. | ||
| 3. Run `docker ps -a` to see if all containers are shut down correctly. | ||
|
|
||
| :bulb: If you want to use a custom docker-compose file, create it and assign the path to your custom dc-file in the [`.env`](./.env) file to the variable `CUSTOM_DOCKER_COMPOSE_FILE`. Then run the custom deplyment by running `bash ./start_rdatascience.sh`. | ||
|
|
||
| ## Build a new version of the image(s) | ||
|
|
||
| To build all images new, run | ||
|
|
||
| ```sh | ||
| ## Run the script to build the image(s): | ||
| sudo bash ./build_rdsc.sh | ||
| ``` | ||
|
|
||
| ## More Infos | ||
|
|
||
| - About RStudio Server: <https://www.rstudio.com/products/rstudio/download-server/> | ||
| - About Shiny: <https://www.rstudio.com/products/shiny/> | ||
| - RStudio and Shiny are trademarks of RStudio, Inc. | ||
|
|
||
| ## Contributions | ||
|
|
||
| Big thanks to [@kapsner](https://github.com/kapsner) for the inspiration of this fork: <https://github.com/kapsner/docker_images>! |