Skip to content

Latest commit

 

History

History
149 lines (92 loc) · 7.24 KB

README.md

File metadata and controls

149 lines (92 loc) · 7.24 KB
Raw

CoiniumServ Build Status Build status Documentation Status Project Stats

CoiniumServ is a high performance, extremely efficient, platform-agnostic, easy to setup pool server implementation. It features stratum and vanilla services, reward, payment, share processors, vardiff & ban managers, user-friendly embedded web-server & front-end and a full-stack API.

Even better multi-pool & auto-exchange module is being developed which once completed will allow you to setup pools that can pay users in any crypto-currency that can be traded over exchanges.

CoiniumServ was created to be used for Coinium.org mining pool network at first hand. You can check some of pools of the pools running CoiniumServ.

Screenshots

Console

CoiniumServ running over mono & ubuntu

Embedded web frontend

Embedded web frontend

Status

Latest release: v0.2.4 beta

Getting Started

Start by checking our Getting Started guide for installation instructions for *nix and Windows.

Documentation

User Support

Start by reading our FAQ and wiki. If you need further help, join us over our IRC channel. You can also use our issues page to report bugs.

Where to get support?
Binary distributions

You can purchase binary distribution for easier setup and meanwhile support the development of the project.

Support the project

You can support the development of the project with different methods;

Bountysource tip for next commit Gratipay

Donations

You can contribute the development of the project by donating;

  • BTC: 18qqrtR4xHujLKf9oqiCsjmwmH5vGpch4D
  • LTC: LMXfRb3w8cMUBfqZb6RUkFTPaT6vbRozPa
  • DOGE: DM8FW8REMHj3P4xtcMWDn33ccjikCWJnQr
  • RDD: Rb9kcLs96VDHTmiXVjcWC2RBsfCJ73UQyr

If you would like to automatically donate a percentage of your pool's earning to support the project, check the donation setup guide.

Donors

Here is a list of our generous donors that keep the project ongoing;

Features

  • Platform Agnostic; unlike other pool-servers, CoiniumServ doesn't dictate platforms and can run on anything including Windows, Linux or MacOS.
  • High Performance; Designed to be fast & efficient, CoiniumServ can handle dozens of pools together.
  • Modular & Flexible; Designed to be modular since day one so that you can implement your very own ideas.
  • Free & Open-Source; Best of all CoiniumServ is open source and free-to-use. You can get it running for free in minutes.
  • Easy to Setup; We got your back covered with our guides & how-to's, irc channel. On top that, we do also provide paid support & consulting services.
General
  • Multiple pools & ports
  • Multiple coin daemon connections
  • Supports POW (proof-of-work) coins
  • Supports POS (proof-of-stake) coins
Auto Exchange & Multipool
  • Being developed, stay tuned!
Algorithms
  • Scrypt, SHA256d, X11, X13, X14, X15, X17, Blake, Fresh, Fugue, Groestl, Keccak, NIST5, Scrypt-OG, Scrypt-N, SHA1, SHAvite3, Skein, Qubit
Protocols
  • Stratum
  • show_message support
  • block template support
  • generation transaction support
  • transaction message (txMessage) support
  • Getwork [experimental]
Storage Layers
  • Hybrid mode (redis + mysql)
  • MPOS compatibility (mysql)
Embedded Web Server
  • Customizable front-end
  • Full stack json-api
Addititional Features
  • ✔ Vardiff support
  • ✔ Ban manager (that can handle miners flooding with invalid shares)
  • ✔ Share & Payment processor, Job Manager

Development

Model
  • We have implemented extensive tests for all important functionality and never merge in code that breaks tests and stuff. Yet again, when a new functionality is introduced we also expect proper tests to be implemented within the PR. In simple words, most probably you won't notice any functionality-breaking changes within the repository.
  • A strict ruleset for the Development Model. You can follow our bleeding-edge Develop branch or stay with-in the stable Master branch.
Contributing

Start reading by these;

License

Copyright (C) 2013 - 2015, CoiniumServ Project - http://www.int6ware.com/

This software is dual-licensed: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

For the terms of this license, see licenses/gpl_v3.txt.

Alternatively, you can license this software under a commercial license or white-label it as set out in licenses/commercial.md.