mirror of
https://github.com/alexgo-io/stacks-puppet-node.git
synced 2026-06-04 19:40:05 +08:00
109 lines
5.0 KiB
Markdown
109 lines
5.0 KiB
Markdown
# Blockstack Core
|
||
|
||
[](https://pypi.python.org/pypi/blockstack-server/)
|
||
[](http://slack.blockstack.org/)
|
||
|
||
Blockstack is a new decentralized web, where users own their data and apps run on user devices without the need for hosting. Developers can build
|
||
serverless apps without the need to trust any centralized services or infrastructure.
|
||
|
||
For more info on Blockstack see: http://github.com/blockstack/blockstack
|
||
|
||
**Blockstack Core is the reference implementation of Blockstack.** It is responsible for processing blockchain transactions, creating virtualchain state, and building the peer network amongst other things. Blockstack Core provides a RESTful interface for clients and also comes with a command-line-interface (CLI).
|
||
|
||
## Table of Contents
|
||
|
||
- [Quick Start](#quick-start)
|
||
- [Development Status](#development-status)
|
||
- [Blockstack Docs](#blockstack-docs)
|
||
- [Contributing](#contributing)
|
||
- [Community](#community)
|
||
|
||
## Quick Start
|
||
|
||
The fastest way to get started with Blockstack is with pip.
|
||
|
||
For Debian & Ubuntu:
|
||
```
|
||
$ sudo apt-get update && sudo apt-get install -y python-pip python-dev libssl-dev libffi-dev rng-tools libgmp3-dev
|
||
$ sudo pip2 install blockstack
|
||
```
|
||
For macOS:
|
||
```
|
||
$ brew install gmp libffi openssl
|
||
$ sudo pip install --upgrade pip
|
||
$ sudo pip install blockstack
|
||
```
|
||
|
||
You can test your installation by trying:
|
||
```
|
||
$ blockstack info
|
||
```
|
||
which should display the last block processed and the latest consensus hash.
|
||
|
||
After installation, you can (optionally) do a fast-sync that quickly syncs your node with the network:
|
||
```bash
|
||
$ blockstack-core --debug fast_sync http://fast-sync.blockstack.org/snapshot.bsk
|
||
```
|
||
|
||
And start Blockstack Core to index the blockchain:
|
||
```bash
|
||
$ blockstack-core --debug start
|
||
$ tail -f ~/.blockstack-server/blockstack-server.log
|
||
```
|
||
|
||
Next, visit the [basic usage docs](https://blockstack.org/docs/basic-usage) and [extended usage docs](https://blockstack.org/docs/basic-usage) to learn how to register names of your own, as well as transfer them and associate data with them.
|
||
|
||
If you encounter any technical issues in installing or using Blockstack, please [search the open issues](https://github.com/blockstack/blockstack-core/issues) and start a new one if your issue is not covered.
|
||
|
||
## Development Status
|
||
|
||
**v0.14.1** is the current stable release of Blockstack Core (available on the master branch).<br>
|
||
**v0.14.2** is the next release candidate for Blockstack Core (available on the [v0.14.2 branch](https://github.com/blockstack/blockstack-core/tree/rc-0.14.2)). See the [release notes](https://github.com/blockstack/blockstack-core/blob/master/release_notes/changelog-0.14.1.md).
|
||
|
||
Most of the development is happening in the [v0.14.2 branch](https://github.com/blockstack/blockstack-core/tree/rc-0.14.2). Please submit all
|
||
pull requests to that branch.
|
||
|
||
## Blockstack Docs
|
||
|
||
You can learn more by visiting [the Blockstack Website](https://blockstack.org) and checking out the in-depth articles and documentation:
|
||
|
||
- [How Blockstack Works](https://blockstack.org/docs/how-blockstack-works)
|
||
- [Blockstack vs. DNS](https://blockstack.org/docs/blockstack-vs-dns)
|
||
- [Blockstack vs. Namecoin](https://blockstack.org/docs/blockstack-vs-namecoin)
|
||
- [Blockstack Namespaces](https://blockstack.org/docs/namespaces)
|
||
- [Blockstack Light Clients](https://blockstack.org/docs/light-clients)
|
||
|
||
You can also read the Blockstack paper:
|
||
|
||
- ["Blockstack: A Global Naming and Storage System Secured by Blockchains"](https://blockstack.org/blockstack.pdf), Proc. USENIX Annual Technical Conference (ATC ’16), June 2016
|
||
|
||
If you have high-level questions about Blockstack, try [searching our forum](https://forum.blockstack.org) and start a new question if your question is not answered there.
|
||
|
||
## Contributing
|
||
|
||
We welcome any small or big contributions! Please take a moment to
|
||
[review the guidelines for contributing to open source](https://guides.github.com/activities/contributing-to-open-source/) in order to make the contribution process easy and effective for everyone involved.
|
||
|
||
**Developers**: You can try out Blockstack Core in a local sandbox using our [integration test framework](https://github.com/blockstack/blockstack-integration-tests).
|
||
|
||
You can install the latest release candidate by:
|
||
```bash
|
||
$ git clone https://github.com/blockstack/blockstack-core.git
|
||
$ blockstack-core/images/scripts/debian-release-candidate.sh
|
||
```
|
||
|
||
## Community
|
||
|
||
We have an active community of developers and the best place to interact with the community is:
|
||
|
||
- [Mailing List](http://blockstack.us14.list-manage1.com/subscribe?u=394a2b5cfee9c4b0f7525b009&id=0e5478ae86) (3,000+ members)
|
||
- [Blockstack Forum](http://forum.blockstack.org)
|
||
- [Live chat on Slack](http://chat.blockstack.org/) (2,400+ members)
|
||
|
||
## Copyright and License
|
||
|
||
The code and documentation copyright are attributed to blockstack.org for the year of 2017.
|
||
|
||
This code is released under
|
||
[the GPL v3 license](http://www.gnu.org/licenses/quick-guide-gplv3.en.html), and the docs are released under [the Creative Commons license](http://creativecommons.org/).
|