Giter VIP home page Giter VIP logo

registration_server's Introduction

Registration server

Build Status codecov license

This server exposes a HTTP(S) API that lets you register a gateway with the server.

Usage

USAGE:
    main [OPTIONS]

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information

OPTIONS:
        --api-ttl <ttl>                   TTL of the DNS records for the api subdomain, in seconds.
        --caa-record <record>             The CAA record the PowerDNS server should return.
        --config-file <path>              Path to a toml configuration file.
        --confirmation-body <s>           The body of the confirmation email.
        --confirmation-title <s>          The title of the confirmation email.
        --db-path <path>                  The database path: file path, postgres://..., mysql://...
        --dns-ttl <ttl>                   TTL of the SOA/NS/MX/TXT/CAA DNS records, in seconds.
        --domain <domain>                 The domain that will be tied to this registration server.
        --email-password <pass>           The password for this email account.
        --email-sender <email>            The email identity to use as a sender.
        --email-server <name>             The name of the SMTP server.
        --email-user <username>           The username to authenticate with.
        --error-page <s>                  HTML content of the email confirmation error page.
        --geoip-continent-af <ip>         The IP address of the tunnel endpoint for Africa.
        --geoip-continent-an <ip>         The IP address of the tunnel endpoint for Antarctica.
        --geoip-continent-as <ip>         The IP address of the tunnel endpoint for Asia.
        --geoip-continent-eu <ip>         The IP address of the tunnel endpoint for Europe.
        --geoip-continent-na <ip>         The IP address of the tunnel endpoint for North America.
        --geoip-continent-oc <ip>         The IP address of the tunnel endpoint for Oceania.
        --geoip-continent-sa <ip>         The IP address of the tunnel endpoint for South America.
        --geoip-database <path>           Path to the GeoIP2/GeoLite2 database.
        --geoip-default <ip>              The IP address of the default tunnel endpoint.
        --host <host>                     Set local hostname.
        --http-port <port>                Set port to listen on for HTTP connections (0 to turn off).
        --https-port <port>               Set port to listen on for TLS connections (0 to turn off).
        --identity-directory <dir>        Identity directory.
        --identity-password <password>    Identity password.
        --mx-record <record>              The MX record the PowerDNS server should return.
        --ns-record <record>...           An NS record the PowerDNS server should return as host=ip (can be specified
                                          multiple times).
        --psl-record <record>             The TXT record used to authenticate against the Public Suffix List.
        --reclamation-body <s>            The body of the domain reclamation email.
        --reclamation-title <s>           The title of the domain reclamation email.
        --soa-record <record>             The SOA record the PowerDNS server should return.
        --socket-path <path>              The path to the socket used to communicate with PowerDNS.
        --success-page <s>                HTML content of the email confirmation success page.
        --tunnel-ttl <ttl>                TTL of the DNS records for tunnels, in seconds.
        --txt-record <record>             The TXT record the PowerDNS server should return.

See the config/config.toml for an example configuration file.

Building & Testing

  • First, select the database type you'd like: mysql, postgres, sqlite
  • Run cargo build --features <db_type> to build.
  • Run ./run_tests.sh to test.

Deploying

Deployment details are provided in the deployment guide.

API

The API is documented here. Its usage is described in this document.

registration_server's People

Contributors

fabricedesre avatar andrenatal avatar mrstegeman avatar ferjm avatar samgiles avatar benfrancis avatar hfiguiere avatar michielbdejong avatar

Watchers

James Cloos 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.