Coder Social home page Coder Social logo

wetzelbe / owntracks-omlox Goto Github PK

View Code? Open in Web Editor NEW
1.0 2.0 0.0 1.65 MB

Code for connecting Owntracks with omlox

License: MIT License

JavaScript 45.15% Dockerfile 0.61% HTML 39.37% CSS 14.87%
omlox-hub owntracks-omlox docker-network mqtt-broker dockerfile deephub docker mqtt owntracks

owntracks-omlox's Introduction

๐Ÿ“ owntracks-omlox

This Node.js program allows synchronisation between a Owntracks system and the omlox hub. It will share positiondata in both directions. More information about omlox here. Available at hub.docker.com.

๐Ÿ”ง Configuration

To configure the system, you can either use command line arguments or you can use environment variables.

๐Ÿ’ป Command Line Arguments

Command-line-arguments are:

  • -o: hostname of the omlox hub, standard is localhost
  • -r: port of the omlox hub, standard is 8081
  • -n: hostname of the MQTT Broker, standard is localhost
  • -q: port of the MQTT Broker, standard is 1883
  • -u: username for authentication, standard is using no authentication
  • -p: password for authentication, standard is using no authentication

๐Ÿ—ป Environment Variables

  • OMLOX_HOSTNAME: see -o
  • OMLOX_PORT: see -r
  • OMLOX_PATH_PREFIX: set path that is added in front of API calls to omlox hub
  • MQTT_HOSTNAME: see -n
  • MQTT_PORT: see -q
  • MQTT_USERNAME: see -u
  • MQTT_PASSWORD: see -p

Docker Installation

๐Ÿšง Build from Dockerfile

You can build a Docker image using the given Dockerfile:

cd owntracks-omlox
docker build -t owntracks-omlox:0.0.1 .

๐Ÿš€ Run the image

When the omlox hub is running in another Container on the same machine, you have to use a network bridge to connect them:
Create a network:

docker network create omlox-network

Connect the omlox-hub container to the network:

docker network connect omlox-network omlox-hub-container-name

Run the owntracks-omlox container connected to the network:

docker run --name name --network omlox-network owntracks-omlox:0.0.1 -- -n mqttBroker -u username -p password -o omlox-hub-host

owntracks-omlox's People

Contributors

dependabot[bot] avatar wetzelbe avatar

Stargazers

 avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.