Skip to content

Commit

Permalink
[NOD-495] Deleted everything except dnsseeder
Browse files Browse the repository at this point in the history
  • Loading branch information
svarogg committed Dec 17, 2019
1 parent 03b7af9 commit d187284
Show file tree
Hide file tree
Showing 701 changed files with 55 additions and 153,940 deletions.
955 changes: 0 additions & 955 deletions CHANGES

This file was deleted.

10 changes: 0 additions & 10 deletions Jenkinsfile

This file was deleted.

4 changes: 1 addition & 3 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
ISC License

Copyright (c) 2018-2019 The kaspanet developers
Copyright (c) 2013-2018 The btcsuite developers
Copyright (c) 2015-2016 The Decred developers
Copyright (c) 2018 The Decred developers

Permission to use, copy, modify, and distribute this software for any
purpose with or without fee is hereby granted, provided that the above
Expand Down
75 changes: 27 additions & 48 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,19 @@

Kaspad
====
Warning: This is pre-alpha software. There's no guarantee anything works.
====

[![ISC License](http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)
[![GoDoc](https://img.shields.io/badge/godoc-reference-blue.svg)](http://godoc.org/github.com/kaspanet/kaspad)

Kaspad is the reference full node Kaspa implementation written in Go (golang).

This project is currently under active development and is in a pre-Alpha state.
Some things still don't work and APIs are far from finalized. The code is provided for reference only.
dnsseeder
=========

## Requirements

Latest version of [Go](http://golang.org) (currently 1.13).

## Installation
Latest version of [Go](http://golang.org) (currently 1.13)

#### Build from Source
## Getting Started

- Install Go according to the installation instructions here:
http://golang.org/doc/install

- Ensure Go was installed properly and is a supported version:

- Launch a kaspad node for the dnsseeder to connect to

```bash
$ go version
$ go env GOROOT GOPATH
Expand All @@ -35,45 +24,35 @@ recommended that `GOPATH` is set to a directory in your home directory such as
`~/dev/go` to avoid write permission issues. It is also recommended to add
`$GOPATH/bin` to your `PATH` at this point.

- Run the following commands to obtain and install kaspad including all dependencies:
- Run the following commands to obtain dnsseeder, all dependencies, and install it:

```bash
$ git clone https://github.com/kaspanet/kaspad $GOPATH/src/github.com/kaspanet/kaspad
$ cd $GOPATH/src/github.com/kaspanet/kaspad
$ ./test.sh
$ go install . ./cmd/...
$ git clone https://github.com/kaspanet/dnsseeder $GOPATH/src/github.com/kaspanet/dnsseeder
$ cd $GOPATH/src/github.com/kaspanet/dnsseeder
$ go install .
```
`./test.sh` tests can be skipped, but some things might not run correctly on your system if tests fail.

- Kaspad (and utilities) should now be installed in `$GOPATH/bin`. If you did
not already add the bin directory to your system path during Go installation,
you are encouraged to do so now.

- dnsseeder will now be installed in either ```$GOROOT/bin``` or
```$GOPATH/bin``` depending on your configuration. If you did not already
add the bin directory to your system path during Go installation, we
recommend you do so now.

## Getting Started

Kaspad has several configuration options available to tweak how it runs, but all
of the basic operations work with zero configuration.
To start dnsseeder listening on udp 127.0.0.1:5354 with an initial connection to working testnet node running on 127.0.0.1:

#### Linux/BSD/POSIX/Source

```bash
$ ./kaspad
```
$ ./dnsseeder -n nameserver.example.com -H network-seed.example.com -s 127.0.0.1 --testnet
```

## Discord
Join our discord server using the following link: https://discord.gg/WmGhhzk

## Issue Tracker

The [integrated github issue tracker](https://github.com/kaspanet/kaspad/issues)
is used for this project.

## Documentation

The documentation is a work-in-progress. It is located in the [docs](https://github.com/kaspanet/kaspad/tree/master/docs) folder.
You will then need to redirect DNS traffic on your public IP port 53 to 127.0.0.1:5354
Note: to listen directly on port 53 on most Unix systems, one has to run dnsseeder as root, which is discouraged

## License
## Setting up DNS Records

Kaspad is licensed under the [copyfree](http://copyfree.org) ISC License.
To create a working set-up where dnsseeder can provide IPs to kaspad instances, set the following DNS records:
```
NAME TYPE VALUE
---- ---- -----
[your.domain.name] A [your ip address]
[ns-your.domain.name] NS [your.domain.name]
```

Loading

0 comments on commit d187284

Please sign in to comment.