Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tmorin/cryptonote-universal-pool-list
The most comprehensive list of cryptonote-universal-pool's instances.
https://github.com/tmorin/cryptonote-universal-pool-list
Last synced: 12 days ago
JSON representation
The most comprehensive list of cryptonote-universal-pool's instances.
- Host: GitHub
- URL: https://github.com/tmorin/cryptonote-universal-pool-list
- Owner: tmorin
- License: gpl-3.0
- Archived: true
- Created: 2017-11-17T13:29:56.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2018-06-17T06:55:15.000Z (over 6 years ago)
- Last Synced: 2024-08-01T19:32:13.382Z (3 months ago)
- Language: JavaScript
- Homepage: http://intensecoin-pools.morin.io
- Size: 1.7 MB
- Stars: 14
- Watchers: 6
- Forks: 33
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# cryptonote-universal-pool-list
> The most comprehensive list of [cryptonote-universal-pool]'s instances.
> Highly inspired by [www.sumopools.com].
[www.sumopools.com]: http://www.sumopools.com
[cryptonote-universal-pool]: https://github.com/fancoder/cryptonote-universal-pool
## Basic features
- Customizable per currency
- Server configuration based on file system, one file === one server
- coinmarket.com integration
- Exchange integrations
- GitHub issue integration
- Google Analytic support (optional)
- Donation list (optional)
- docker image
## Customization
In order to run you own `cryptonote-universal-pool-list`, you have to fork this repository.
Then from your own repository, follow the documentation below and override stuff which sould be overridden.
### Main configuration
The file `src/config/main.json` is containing the main configuration.
The configuration is split by domains.
#### currency
It is about the mined currency. i.e. the name, symbol etc.
```json
{
"currency": {
"name": "Intense Coin",
"short_name": "Intense",
"tech_name": "intensecoin",
"symbol": "ITNS",
"difficultyTarget": 120
}
}
```
`tech_name` is used to locate the config directory (`src/config/`) as well as the domain name (`.circleci/config.yml`).
`difficultyTarget` is used to estimate the network hashrate.
#### links
From the front page, links can be displayed just below the site's tile.
Those links are configurable under the *links domain*, like below:
```json
{
"links": {
"intensecoin.com": {
"icon": "fa fa-home",
"url": "https://intensecoin.com"
}
}
}
```
The icon value is in fact the content of a `class` attribute related to an empty tag ``.
So, the content is dedicated for library like [fontawesome.io].
[fontawesome.io]: http://fontawesome.io/
#### exchanges
From the front page, there is a block dedicated to exchanges web-site.
The content of this block is related to the *exchanges domain*.
Each exchanges is be described with a logo and a URL.
The key, there `stocks.exchange`, will be the `alt` attribute of the `img` element.
```json
{
"exchanges": {
"stocks.exchange": {
"logo": "images/logo.stocks.exchange.png",
"url": "https://stocks.exchange/trade/ITNS/BTC"
}
}
}
```
#### coinmarket
From the front page, on the right of the site's title, a coinmarket widget can be displayed according to the *coinmarket domain*.
Please refer to [coinmarketcap's documentation] for more information.
```json
{
"coinmarket": {
"currency": "intensecoin",
"base": "USD",
"secondary": "BTC",
"ticker": "true",
"rank": "true",
"marketcap": "true",
"volume": "true",
"stats": "USD",
"statsticker": "false"
}
}
```
[coinmarketcap's documentation]:https://coinmarketcap.com/widget
#### donations
Before the footer of the front page, a donations block can be displayed according to the *donations domain*.
```json
{
"donations": {
"ITNS": "iz4gonVSZ1AiaxqBy9FZwFLu671VhTcfAjRfWUvmNjNV2K1xSrzr6WCRJHG8ib92rKDWMYLqq8jbU7LZMqbavGir1aCRWLnw4",
"BTC": "13jXtnauRQf4eqXUQmH2MnAHLSp5Wefmjd"
}
}
```
#### administrator
The *administrator domain* is there to setup the administrator details like the email.
`request_user` and `request_repo` are used to configure the form creating the GitHub issues.
```json
{
"administrator": {
"email": "[email protected]",
"request_user": "tmorin",
"request_repo": "cryptonote-universal-pool-list"
}
}
```
#### analytic
To activate Google Analytic, the
```json
{
"analytic": {
"ga": "XX-XXXXXXXX-X"
}
}
```
#### worker
The *domain worker* is dedicated to the back part.
`interval_ms` is interval between to refresh of the stats. By default the value is 5 minutes.
```json
{
"worker": {
"interval_ms": 300000
}
}
```
#### Icons
The icons of the front page has to be customized there: `src/front/images/icons`.
### Servers
The server definitions are located in `src/config/servers`.
There is one file per servers.
The name of the file is the key of the server from the front ent point of view.
The content of a file is a JSON document describing:
- the name of the server
- the URL of the front
- the URL of the back
- the location
- the implementation: `nodejs-pool` or `cryptonote-universal-pool`, by default it's `cryptonote-universal-pool`
- the boolean disabled
For instance:
```json
{
"name": "intensecoin.com",
"front": "http://intensecoin.com/pool",
"back": "http://45.32.171.89:8111",
"location": "US"
}
```
### Deployment
`cryptonote-universal-pool-list` is ready to be deployed over docker.
There is script doing the stuff: `scripts/deploy.sh`.
The script is expecting to be run in a docker environment where [nginx-proxy] and [docker-letsencrypt-nginx-proxy-companion] are ready.
To customize the domain name and SSL configuration, the following environment variables have to be customized:
- ENV_NAME
- VIRTUAL_HOST
- LETSENCRYPT_HOST
- LETSENCRYPT_EMAIL
[nginx-proxy]: https://hub.docker.com/r/jwilder/nginx-proxy
[docker-letsencrypt-nginx-proxy-companion]: https://github.com/JrCs/docker-letsencrypt-nginx-proxy-companion
## Development tasks
Install the dependencies
```bash
npm run build
```
Start the back in development mode
```bash
npm run watch:back:
```
Start the front in development mode
```bash
npm run watch:front
```
Build the production sources
```bash
npm run build
```
Call the deploy script to build and start the updated container.
```bash
npm run deploy
```
## Donations
- BTC: `13jXtnauRQf4eqXUQmH2MnAHLSp5Wefmjd`
## License
Released under the GNU General Public License v3