Skip to content

Commit a351ed5

Browse files
Update README.md (#34)
1 parent 265e911 commit a351ed5

File tree

1 file changed

+12
-5
lines changed

1 file changed

+12
-5
lines changed

README.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -46,14 +46,17 @@ in your computer by going to the project folder and running:
4646

4747
```bash
4848
./setup-testing-mode.sh # setup files for testing and download Docker images
49-
docker compose --profile dev up -d # start services and RStudio in detached mode
49+
docker compose --profile dev up -d # start server in the `dev` profile and detached mode
5050
```
5151

5252
You can now visit http://localhost in your web browser. The services should be
5353
fully operational in about ~30 seconds. Specific services may only be accessible
5454
via their port, e.g. http://localhost:8000 for plausible and
5555
http://localhost:8787 for RStudio.
5656

57+
> [!NOTE]
58+
> Some services are only available in the `dev` profile (RStudio).
59+
5760
### Production environment
5861

5962
Some services are given a default email, user and/or password. The default ones
@@ -87,12 +90,16 @@ docker compose up -d # start services in detached mode
8790

8891
You can now visit http://localhost in your web browser.
8992

90-
> Some services are only available in the `dev` profile (RStudio). To
91-
> run this profile, type:
92-
> ```bash
93-
> docker compose --profile dev up -d
93+
> [!TIP]
94+
> If you are using a remote machine, [port forwarding][tunneling] allows to access
95+
> specific services in your browser. For instance, to access http://localhost:8000
96+
> (plausible) in your browser, you first need to connect to the machine like so:
97+
> ```
98+
> ssh -L 8000:localhost:8000 [server]
9499
> ```
95100
101+
[tunneling]: https://en.wikipedia.org/wiki/Port_forwarding
102+
96103
## Next steps
97104
98105
- [Add and update apps in ShinyProxy](shinyproxy)

0 commit comments

Comments
 (0)