https://github.com/t-matsuo/docker-ttyd

https://github.com/t-matsuo/docker-ttyd

Last synced: 7 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/t-matsuo/docker-ttyd
• Owner: t-matsuo
• License: mit
• Created: 2020-11-03T11:28:54.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2020-11-10T12:56:43.000Z (almost 5 years ago)
• Last Synced: 2025-01-28T13:49:27.383Z (8 months ago)
• Language: Shell
• Size: 22.5 KB
• Stars: 0
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# docker-ttyd

Dockerfile to start web based terminal(ttyd) with pam auth using nginx reverse proxy.

# Usage

```

docker run -d -p 443:8080 -e USER=foo -e PASSWORD=mypassword --name ttyd tmatsuo/ttyd

```

Access https://your-server-ip/ and login with ID=foo,PASSWORD=mypassword.

## Environment

* PORT

   * listen port

* USER

   * user name

   * `default: root`

* USER_ID

   * if USER is not root, you can specify UID.

   * `default: 1000`

* GROUP_ID

   * if USER is not root, you can specify GID.

   * `default: (useradd command generates '1000' automatically)`

* PASSWORD

   * user password

   * if it's not set, random passwd is generated.

       * see container log

* ENABLE_SUDO (true/false)

   * specified `USER` can use sudo command with no password.

   * `default: false`

* TTYD_OPTS

   * ttyd args

   * `default: -p 10022 -P 30 -i lo /bin/bash`

       * don't change port `10022` which is specified by nginx reverse proxy.

* NOSSL

   * disable https. (true/false)

   * `default: false`

   * you can specify key and crt file if NOSSL=false

       * ex (docker run with -v option)

       * -v /path/to/server.key:/etc/pki/nginx/server.key -v /path/to/server.crt:/etc/pki/nginx/server.crt