Skip to content

Commit c5d62d6

Browse files
authored
Add instructions
1 parent 3406cbe commit c5d62d6

File tree

1 file changed

+27
-1
lines changed

1 file changed

+27
-1
lines changed

README.md

+27-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,33 @@
22

33
JetBrains Gateway SSH was made to provide a clean SSH server for JetBrains Gateway.
44

5-
## Setup
5+
## Getting started
6+
7+
JetBrains Gateway SSH is pushed to Docker Hub. You can use this docker-compose.yml example to quickly start a container:
8+
9+
```
10+
version: "3.1"
11+
services:
12+
jetbrains-gateway-ssh:
13+
image: vollborn/jetbrains-gateway-ssh
14+
environment:
15+
SSH_USERNAME: "${SSH_USERNAME:-jetbrains}"
16+
SSH_PASSWORD: "${SSH_PASSWORD:-jetbrains}"
17+
volumes:
18+
- "./home:/opt/home"
19+
ports:
20+
- "${SSH_PORT:-22}:22"
21+
```
22+
23+
You should change the default password and username by creating an .env file with your own credentials:
24+
25+
```
26+
SSH_PORT=22
27+
SSH_USERNAME=jetbrains
28+
SSH_PASSWORD=myownpassword
29+
```
30+
31+
## Development
632

733
1. Clone the repository
834
```shell

0 commit comments

Comments
 (0)