Git Product home page Git Product logo

duckypanel's Introduction

NOTE: This project is still a work in progress. You can already check it out if you're curious, but I can't guarantee it will work out for you.

DuckyPanel

Duckypanel is a domain admin level control panel for the modern WildDuck email server. DuckyPanel is just an Angular frontend project. It uses the DuckyAPI REST API as the backend.

Current features

Things currently working in DuckyPanel and DuckyAPI.

  • Authentication
  • API keys allow you to easily call DuckyAPI
  • Packages that allow you to set user quotas, currently only for show. Nothing happens when going over quota.
  • Domain management, including domain aliases
  • Deletes aliased domains, accounts, forwarders and DKIM when deleting a domain
  • Manage DKIM for the domains
  • Email account management, including account aliases
  • Forwarder management
  • Only allows seeing/editing of accounts/forwarders on a domain if that domain is added to the account
  • Domains can not be added to multiple accounts
  • Get expected DNS records for a domain, and check the currently published records
  • Sorting and filtering

More to come!

Screenshots

Accounts overview screenshot

Click here for more screenshots

Edit account screenshot Domains overview screenshot Edit DKIM screenshot Forwarders overview screenshot Edit forwarder screenshot Check domain DNS screenshot Profile screenshot Login screenshot Mobile screenshot

Dependencies

  • DuckyAPI
  • A web server (if in production)
  • Node.js (if in development)

Option 1: Serve DuckyPanel from DuckyApi

Very easy to get started with. See the instructions here.

Option 2: Serve DuckyPanel seperately from DuckyApi

Recommended if you want to scale and distribute the applications differently. As an example you could host DuckyPanel on a fast CDN.

Get it

Get the latest release here and unzip it.

Configure it

Copy config/example.json to config/production.json. Then edit apiUrl to be your publically accessible url of DuckyAPI, so DuckyPanel knows where to reach it.

Serve it

Now you can serve DuckyPanel with any webserver you're comfortable with. You will need to configure the server to fall back to index.html for the routing to work properly. Here are some configuration examples for the most popular web servers.

Development

Install it

$ git clone https://github.com/louis-lau/DuckyPanel
$ npm install

Configure it

Copy src/config/example.json to src/config/development.json. Then edit apiUrl to be your DuckyApi url.

Start hacking!

Run npm start for a dev server. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files. Do not use this in production.

duckypanel's People

Contributors

louis-lau avatar snyk-bot 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.