Skip to content

Commit 4d5e3e5

Browse files
committed
Added Documentation for using ssh on workspace
1 parent aa7c52c commit 4d5e3e5

1 file changed

Lines changed: 17 additions & 2 deletions

File tree

README.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ It's like Laravel Homestead but for Docker instead of Vagrant.
3737
- [List current running Containers](#List-current-running-Containers)
3838
- [Close all running Containers](#Close-all-running-Containers)
3939
- [Delete all existing Containers](#Delete-all-existing-Containers)
40-
- [Enter a Container (SSH into a running Container)](#Enter-Container)
40+
- [Enter a Container (run commands in a running Container)](#Enter-Container)
4141
- [Edit default container configuration](#Edit-Container)
4242
- [Edit a Docker Image](#Edit-a-Docker-Image)
4343
- [Build/Re-build Containers](#Build-Re-build-Containers)
@@ -63,6 +63,7 @@ It's like Laravel Homestead but for Docker instead of Vagrant.
6363
- [Misc](#Misc)
6464
- [Change the timezone](#Change-the-timezone)
6565
- [Cron jobs](#CronJobs)
66+
- [Access workspace via ssh](#Workspace-ssh)
6667
- [MySQL access from host](#MySQL-access-from-host)
6768
- [Use custom Domain](#Use-custom-Domain)
6869
- [Enable Global Composer Build Install](#Enable-Global-Composer-Build-Install)
@@ -388,7 +389,7 @@ docker-compose down
388389

389390
<br>
390391
<a name="Enter-Container"></a>
391-
### Enter a Container (SSH into a running Container)
392+
### Enter a Container (run commands in a running Container)
392393

393394
1 - first list the current running containers with `docker ps`
394395

@@ -1023,6 +1024,20 @@ You can add your cron jobs to `workspace/crontab/root` after the `php artisan` l
10231024

10241025
Make sure you [change the timezone](#Change-the-timezone) if you don't want to use the default (UTC).
10251026

1027+
<a name="Workspace-ssh"></a>
1028+
### Access workspace via ssh
1029+
1030+
You can access the `workspace` container through `localhost:2222` by setting the `INSTALL_WORKSPACE_SSH` build argument to `true`.
1031+
1032+
To change the default forwarded port for ssh:
1033+
1034+
```yml
1035+
workspace:
1036+
ports:
1037+
- "2222:22" # Edit this line
1038+
...
1039+
```
1040+
10261041
<a name="MySQL-access-from-host"></a>
10271042
### MySQL access from host
10281043

0 commit comments

Comments
 (0)