https://github.com/electerm/electerm-web-docker
docker image of electerm-web
https://github.com/electerm/electerm-web-docker
docker elcecterm-web electerm serialport sftp ssh telnet terminal
Last synced: about 1 month ago
JSON representation
docker image of electerm-web
- Host: GitHub
- URL: https://github.com/electerm/electerm-web-docker
- Owner: electerm
- License: mit
- Created: 2023-11-06T11:46:42.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-09T03:17:56.000Z (about 1 month ago)
- Last Synced: 2025-04-09T04:23:13.768Z (about 1 month ago)
- Topics: docker, elcecterm-web, electerm, serialport, sftp, ssh, telnet, terminal
- Language: Shell
- Homepage: https://electerm.html5beta.com/
- Size: 43.9 KB
- Stars: 46
- Watchers: 2
- Forks: 9
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[中文](README_cn.md)
# electerm-web-docker
docker image of [electerm-web](https://github.com/electerm/electerm-web)
## Use
```sh
# change $(pwd)/data to any folder you want to store data
# to use same data as desktop electerm
# for Mac OS modify $(pwd)/electerm-web-data to "/Users//Library/Application Support/electerm"
# for Linux OS modify $(pwd)/electerm-web-data to "/home//.config/electerm"
# for Windows OS modify $(pwd)/electerm-web-data to "C:\\Users\\\\AppData\\Roaming\\electerm"
# SERVER_SECRET, SERVER_PASS, ENABLE_AUTH are optional,
# when ENABLE_AUTH enabled, would require login with SERVER_PASS when visit
# SERVER_SECRET is used to encrypt data, if not set, would use default value
# Should change some_server_secret to some complicated secret string
docker run --init -v $(pwd)/electerm-web-data:/home/electerm/data \
-e "DB_PATH=/home/electerm/data" \
-e "HOST=0.0.0.0" \
# -e "SERVER_SECRET=some_server_secret" \
# -e "SERVER_PASS=password_to_login" \
# -e "ENABLE_AUTH=1" \
-p 8082:5577 \
zxdong262/electerm-web
```
Then visit [http://127.0.0.1:8082](http://127.0.0.1:8082) in browser,
Check [examples/nginx.conf](https://github.com/electerm/electerm-web/blob/main/examples/nginx.conf) [examples/nginx-ssl.conf](https://github.com/electerm/electerm-web/blob/main/examples/nginx-ssl.conf) for domain binding nginx conf example.
## Docker Compose example
```docker
version: '3.8'
services:
electerm-web:
image: https://docker.xuanyuan.me/zxdong262/electerm-web:latest
container_name: electerm-web
volumes:
- /your-local-path-with/proper-permission/try-give-777-permission/if-can-not-create-file:/home/electerm/data
environment:
- DB_PATH=/home/electerm/data
- HOST=0.0.0.0
- SERVER_SECRET=some_server_secret
- SERVER_PASS=password_to_login
- ENABLE_AUTH=1
ports:
- "8082:5577"
init: true
```
```sh
# Replace some_server_secret with a strong cryptographic key
# For users in China: Use the specified mirror at https://docker.xuanyuan.me/zxdong262/electerm-web:latest. Default settings apply for users in other regions.
# Mount the host directory /share/nas973/electerm-web-data to /home/electerm/data in the container. Configure this path according to your storage requirements.
# Setting HOST=0.0.0.0 configures the service to listen on all available network interfaces
# Port mapping: Host port 8082 -> Container port 5577, enabling external access to the containerized service
```
## Docker hub url
https://hub.docker.com/repository/docker/zxdong262/electerm-web
## License
MIT