https://github.com/kaelzhang/docker-image-futuopend

Docker image for FutuOpenD
https://github.com/kaelzhang/docker-image-futuopend

docker-image futu futuopend

Last synced: 12 days ago
JSON representation

Docker image for FutuOpenD

• Host: GitHub
• URL: https://github.com/kaelzhang/docker-image-futuopend
• Owner: kaelzhang
• Created: 2020-01-03T03:18:50.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2023-08-30T07:31:52.000Z (about 1 year ago)
• Last Synced: 2024-04-15T12:32:57.665Z (7 months ago)
• Topics: docker-image, futu, futuopend
• Language: JavaScript
• Size: 29.3 MB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# kaelz/futuopend

Docker image for FutuOpenD on Ubuntu.

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.

```sh

docker pull kaelz/futuopend:latest

```

## Current FutuOpenD Image Version

7.3.3508_Ubuntu16.04

## Environment Variables

- **FUTU_LOGIN_ACCOUNT** required

- **FUTU_LOGIN_PWD_MD5** required

- **FUTU_LOGIN_REGION** defaults to `sh`

- **FUTU_LANG** defaults to `chs`

- **FUTU_LOG_LEVEL** defaults to `no`

- **FUTU_PORT** defaults to `11111`

- **SERVER_PORT** `integer` the port of the websocket server, defaults to `8000`

## How to start the container

```sh

docker run -it -p 11111:11111 \

-e "FUTU_LOGIN_ACCOUNT=$your_futu_id" \

-e "FUTU_LOGIN_PWD_MD5=$your_password_md5" kaelz/futuopend:latest

```

## WebSocket Server

### Incoming Message

- **type** `string` the type of the messages, including following types:

  - REQUEST_VERIFY_CODE: which means the FutuOpenD agent requires you to provide an SMS verification code

  - CONNECTED: which means the FutuOpenD agent is connected

```js

const {WebSocket} = require('ws')

const ws = new WebSocket('ws://localhost:8080')

ws.on('open', () => {

  ws.on('message', msg => {

    const data = JSON.parse(msg)

    if (data.type === 'REQUEST_VERIFY_CODE') {

      ws.send(JSON.stringify({

        type: 'VERIFY_CODE',

        code: '12345'

      }))

    }

  })

})

```

### For Mac

It is not easy to connect to a container from MacOS, to run `test.py` from MacOS, see:

- https://docs.docker.com/docker-for-mac/networking/#known-limitations-use-cases-and-workarounds

- https://github.com/docker/for-mac/issues/2670#issuecomment-372365274

# For contributors

## How to build your own image

```sh

docker build -t $TAG:$VERSION --build-arg .

```

For example:

```sh

docker build -t kaelz/futuopend:2.8.700 .

```