mirror of https://github.com/lukechilds/docs.git
Alexander Graebe
4 years ago
committed by
Alexander Graebe
Alexander Graebe
20 changed files with 17660 additions and 113 deletions
@ -0,0 +1,23 @@ |
|||||
|
{ |
||||
|
"ignorePatterns": [ |
||||
|
{ |
||||
|
"pattern": "^http://localhost" |
||||
|
}, |
||||
|
{ |
||||
|
"pattern": "^https://banter.pub" |
||||
|
} |
||||
|
], |
||||
|
"replacementPatterns": [ |
||||
|
{ |
||||
|
"pattern": "^/public/images", |
||||
|
"replacement": "https://docs.blockstack.org/images" |
||||
|
}, |
||||
|
{ |
||||
|
"pattern": "^/", |
||||
|
"replacement": "https://docs.blockstack.org/" |
||||
|
} |
||||
|
], |
||||
|
"timeout": "10s", |
||||
|
"retryOn429": true, |
||||
|
"retryCount": 5 |
||||
|
} |
||||
File diff suppressed because it is too large
@ -1,93 +0,0 @@ |
|||||
--- |
|
||||
title: Stacks API |
|
||||
description: Step-by-step instructions for deploying a Stacks API node on Debian or Ubuntu are below. |
|
||||
duration: 30 minutes |
|
||||
tags: |
|
||||
- tutorial |
|
||||
--- |
|
||||
|
|
||||
## Introduction |
|
||||
|
|
||||
- **Step 1:** Make sure you have a Stacks Node running locally (see [instructions](https://github.com/blockstack/blockstack-core/blob/master/README.md#quick-start)). |
|
||||
|
|
||||
- **Step 2:** Make sure you have [virtualenv installed](http://docs.python-guide.org/en/latest/dev/virtualenvs/). |
|
||||
Then, setup the API: |
|
||||
|
|
||||
```bash |
|
||||
$ sudo apt-get install -y python-pip memcached rng-tools python-dev libmemcached-dev zlib1g-dev libgmp-dev libffi-dev libssl-dev |
|
||||
$ sudo service memcached start |
|
||||
$ sudo pip install virtualenv |
|
||||
$ sudo npm -g install aglio |
|
||||
$ virtualenv api && source api/bin/activate |
|
||||
$ git clone https://github.com/blockstack/blockstack-core.git |
|
||||
$ cd blockstack-core/ |
|
||||
$ git checkout stacks-1.0 |
|
||||
$ pip install . |
|
||||
$ pip install -r api/requirements.txt |
|
||||
$ blockstack setup_wallet |
|
||||
$ blockstack api start |
|
||||
$ deactivate |
|
||||
$ ./build_docs.sh public_api |
|
||||
``` |
|
||||
|
|
||||
### Search Subsystem |
|
||||
|
|
||||
If you want to enable the search subsystem in your installation, you can |
|
||||
follow the instructions [here](search.html). |
|
||||
|
|
||||
### Nginx Deployment |
|
||||
|
|
||||
For a production deployment we recommend using nginx and uwsgi: |
|
||||
|
|
||||
- **Step 1:** Install nginx and uWSGI: |
|
||||
|
|
||||
```bash |
|
||||
$ sudo apt-get install -y nginx |
|
||||
$ sudo pip install uwsgi |
|
||||
``` |
|
||||
|
|
||||
- **Step 2:** Copy [this sample nginx sites file](../api/nginx/config/nginx_sites-available/blockstack_api) to |
|
||||
|
|
||||
> /etc/nginx/sites-available/blockstack_api |
|
||||
|
|
||||
and edit the paths depending on the uwsgi blockstack_api socket directory (defaults to /tmp/blockstack_api.sock) |
|
||||
You can test your nginx settings: |
|
||||
|
|
||||
```bash |
|
||||
$ sudo nginx -t |
|
||||
``` |
|
||||
|
|
||||
- **Step 3:** Copy [this sample systemd service file](../api/nginx/config/systemd_system/blockstack_api.service) to |
|
||||
|
|
||||
> /etc/systemd/system/blockstack_api.service |
|
||||
|
|
||||
and edit the service user and Blockstack paths depending on where your Blockstack repo is located, and |
|
||||
where your virtualenv is located. |
|
||||
|
|
||||
Note: The following sed commands will work if the virtualenv is currently active and your shell is in the repo's root directory. |
|
||||
|
|
||||
``` |
|
||||
$ sudo sed -i "s/User\=USER/User\=$USER/" /etc/systemd/system/blockstack_api.service |
|
||||
$ sudo sed -i "s#/path/to/blockstack#$PWD#" /etc/systemd/system/blockstack_api.service |
|
||||
$ sudo sed -i "s#/path/to/virtualenv#$VIRTUAL_ENV#" /etc/systemd/system/blockstack_api.service |
|
||||
``` |
|
||||
|
|
||||
- **Step 4:** Get a security certificate from [Let's Encrypt](https://letsencrypt.org/). |
|
||||
|
|
||||
``` |
|
||||
$ git clone https://github.com/certbot/certbot.git |
|
||||
$ cd certbot/ |
|
||||
$ ./certbot-auto --nginx -d <your_domain> |
|
||||
``` |
|
||||
|
|
||||
And copy the cert files to the path given in the nginx sites file earlier. |
|
||||
|
|
||||
- **Step 5:** Start nginx and the Stacks API uwsgi server: |
|
||||
|
|
||||
``` |
|
||||
sudo systemctl restart blockstack_api |
|
||||
sudo systemctl restart nginx |
|
||||
``` |
|
||||
|
|
||||
If you run into any issues, please [submit a Github issue](https://github.com/blockstack/stacks-blockchain/issues) and we'll update these |
|
||||
instructions. |
|
||||
Loading…
Reference in new issue