Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kaelzhang/docker-image-futuopend
Docker image for FutuOpenD, the one that really works and could handle SMS verification requests.
https://github.com/kaelzhang/docker-image-futuopend
docker-image futu futuopend
Last synced: 4 days ago
JSON representation
Docker image for FutuOpenD, the one that really works and could handle SMS verification requests.
- Host: GitHub
- URL: https://github.com/kaelzhang/docker-image-futuopend
- Owner: kaelzhang
- Created: 2020-01-03T03:18:50.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2025-01-09T17:13:09.000Z (about 1 month ago)
- Last Synced: 2025-02-02T13:16:07.673Z (9 days ago)
- Topics: docker-image, futu, futuopend
- Language: JavaScript
- Homepage:
- Size: 29.3 MB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Docker Image: ostai/ FutuOpenD
Docker image for FutuOpenD on Ubuntu, the one that really works and could handle SMS verification requests.
The container will start
- A FutuOpenD agent
- A websocket server which could help to check the ready status of the FutuOpenD agent and make it possible for you to provide SMS verfication code.
The image is always built with `DOCKER_DEFAULT_PLATFORM=linux/amd64` ([why?](https://stackoverflow.com/questions/71040681/qemu-x86-64-could-not-open-lib64-ld-linux-x86-64-so-2-no-such-file-or-direc)) and could be `docker-run` on both Ubuntu and MacOS.
## Install
```sh
docker pull ostai/futuopend:latest
```
Or
```sh
docker pull ostai/futuopend:8.8.4818
```
## Current FutuOpenD Image Version
8.8.4818_Ubuntu16.04
## Usage
### Environment Variables
- **FUTU_LOGIN_ACCOUNT** `string` required
- **FUTU_LOGIN_PWD_MD5** `string` required
- **FUTU_LOGIN_REGION** `string` defaults to `sh`
- **FUTU_LANG** `string` defaults to `chs`
- **FUTU_LOG_LEVEL** `string` defaults to `no`
- **FUTU_PORT** `integer` the port of the FutuOpenD, defaults to `11111`
- **SERVER_PORT** `integer` the port of the websocket server, defaults to `8000`
- **FUTU_INIT_ON_START** `string="yes"` whether it will initialize the Futu OpenD agent on the start, defaults to `"yes"`
### Docker Run: How to start the container
```sh
docker run \
--name FutuOpenD \
-e "SERVER_PORT=8081" \
-p 8081:8081 \
-p 11111:11111 \
-e "FUTU_LOGIN_ACCOUNT=$your_futu_id" \
-e "FUTU_LOGIN_PWD_MD5=$your_password_md5" \
ostai/futuopend:latest
```
### WebSocket Server
```js
const {WebSocket} = require('ws')
const ws = new WebSocket('ws://localhost:8081')
ws.on('message', msg => {
const data = JSON.parse(msg)
if (data.type === 'REQUEST_CODE') {
ws.send(JSON.stringify({
type: 'VERIFY_CODE',
code: '12345'
}))
return
}
if (data.type === 'STATUS') {
console.log('status:', data.status)
return
}
})
ws.on('open', () => {
ws.send(JSON.stringify({
type: 'STATUS'
}))
// If env FUTU_INIT_ON_START=no, we need to manually init futu
ws.send(JSON.stringify({
type: 'INIT'
}))
})
```
Both downstream and upstream messages are in JSON type.
#### Downstream Messages: From Server to Client
```json
{
"type": "REQUEST_CODE"
}
```
which means the FutuOpenD agent requires you to provide an SMS verification code
```json
{
"type": "CONNECTED"
}
```
which means the FutuOpenD agent is connected
```json
{
"type": "STATUS",
"status": -1
}
```
The server returns the current status to you.
#### Upstream Messages: From Client to Server
```json
{
"type": "INIT"
}
```
Tells the server to initialize the Futu OpenD agent, which only works when `FUTU_INIT_ON_START` is set to `'no'`
```json
{
"type": "STATUS"
}
```
Asks the server to response the current status of the server
```json
{
"type": "VERIFY_CODE",
"code": "123456"
}
```
Submits the SMS verification code to Futu OpenD agent.
# For contributors
## How to build your own image
```sh
TAG=ostai/futuopend
VERSION=8.8.4818
FUTU_VERSION="$VERSION"_Ubuntu16.04
docker build -t $TAG:$VERSION \
--build-arg FUTU_VERSION=$FUTU_VERSION \
.
```
For example:
```sh
docker build -t ostai/futuopend:8.8.4818 \
--build-arg FUTU_VERSION=8.8.4818_Ubuntu16.04 \
.
```