diff --git a/docs/README.md b/docs/README.md index 15c3175..3e3d0c7 100644 --- a/docs/README.md +++ b/docs/README.md @@ -5,7 +5,7 @@ SPDX-License-Identifier: (Apache-2.0 AND CC-BY-4.0) Code is Apache-2.0 and docs are CC-BY-4.0 ---> -- [Documentation on ReadTheDocs](http://bigchaindb.readthedocs.org/) +- [Documentation on ReadTheDocs](http://planetmint.readthedocs.org/) - [Planetmint Upgrade Guides](upgrade-guides/) # The Planetmint Documentation Strategy diff --git a/docs/root/generate_http_server_api_documentation.py b/docs/root/generate_http_server_api_documentation.py index b43e163..eb6cc34 100644 --- a/docs/root/generate_http_server_api_documentation.py +++ b/docs/root/generate_http_server_api_documentation.py @@ -9,7 +9,7 @@ import json import os import os.path -from planetmint.common.transaction import Transaction, Input, TransactionLink +from planetmint.iomon.transaction import Transaction, Input, TransactionLink from planetmint import lib from planetmint.web import server diff --git a/docs/root/make.bat b/docs/root/make.bat index 7f41e02..f16aa07 100644 --- a/docs/root/make.bat +++ b/docs/root/make.bat @@ -127,9 +127,9 @@ if "%1" == "qthelp" ( echo. echo.Build finished; now you can run "qcollectiongenerator" with the ^ .qhcp project file in %BUILDDIR%/qthelp, like this: - echo.^> qcollectiongenerator %BUILDDIR%\qthelp\bigchaindb.qhcp + echo.^> qcollectiongenerator %BUILDDIR%\qthelp\planetmint.qhcp echo.To view the help file: - echo.^> assistant -collectionFile %BUILDDIR%\qthelp\bigchaindb.ghc + echo.^> assistant -collectionFile %BUILDDIR%\qthelp\planetmint.ghc goto end ) diff --git a/docs/root/source/about-bigchaindb.rst b/docs/root/source/about-bigchaindb.rst index d72bd64..d693992 100644 --- a/docs/root/source/about-bigchaindb.rst +++ b/docs/root/source/about-bigchaindb.rst @@ -35,7 +35,7 @@ Planetmint can store data of any kind, but it's designed to be particularly good .. note:: - We used the word "owners" somewhat loosely above. A more accurate word might be fulfillers, signers, controllers, or transfer-enablers. See the section titled **A Note about Owners** in the relevant `Planetmint Transactions Spec `_. + We used the word "owners" somewhat loosely above. A more accurate word might be fulfillers, signers, controllers, or transfer-enablers. See the section titled **A Note about Owners** in the relevant `Planetmint Transactions Spec `_. # Production-Ready? @@ -52,7 +52,7 @@ A system could store data off-chain, e.g. in a third-party database, document st - Keep track of who has read permissions (or other permissions) in a third-party system. An example of how this could be done is described below. - Keep a permanent record of all requests made to the third-party system. - Store hashes of documents-stored-elsewhere, so that a change in any document can be detected. -- Record all handshake-establishing requests and responses between two off-chain parties (e.g. a Diffie-Hellman key exchange), so as to prove that they established an encrypted tunnel (without giving readers access to that tunnel). There are more details about this idea in `the Privacy Protocols repository `_. +- Record all handshake-establishing requests and responses between two off-chain parties (e.g. a Diffie-Hellman key exchange), so as to prove that they established an encrypted tunnel (without giving readers access to that tunnel). There are more details about this idea in `the Privacy Protocols repository `_. A simple way to record who has read permission on a particular document would be for the third-party system (“DocPile”) to store a CREATE transaction in a Planetmint network for every document+user pair, to indicate that that user has read permissions for that document. The transaction could be signed by DocPile (or maybe by a document owner, as a variation). The asset data field would contain 1) the unique ID of the user and 2) the unique ID of the document. The one output on the CREATE transaction would only be transferable/spendable by DocPile (or, again, a document owner). diff --git a/docs/root/source/basic-usage.md b/docs/root/source/basic-usage.md index 62b5078..7f8f393 100644 --- a/docs/root/source/basic-usage.md +++ b/docs/root/source/basic-usage.md @@ -17,7 +17,7 @@ two kinds: CREATE transactions and TRANSFER transactions. You can view the transaction specifications in Github, which describe transaction components and the conditions they have to fulfill in order to be valid. -[Planetmint Transactions Specs](https://github.com/bigchaindb/BEPs/tree/master/13/) +[Planetmint Transactions Specs](https://github.com/planetmint/BEPs/tree/master/13/) ### CREATE Transactions @@ -44,7 +44,7 @@ Planetmint supports a variety of conditions. For details, see the section titled **Transaction Components: Conditions** in the relevant -[Planetmint Transactions Spec](https://github.com/bigchaindb/BEPs/tree/master/13/). +[Planetmint Transactions Spec](https://github.com/planetmint/BEPs/tree/master/13/). ![Example Planetmint CREATE transaction](./_static/CREATE_example.png) @@ -58,7 +58,7 @@ Loosely speaking, that list might be interpreted as the list of "owners." A more accurate word might be fulfillers, signers, controllers, or transfer-enablers. See the section titled **A Note about Owners** -in the relevant [Planetmint Transactions Spec](https://github.com/bigchaindb/BEPs/tree/master/13/). +in the relevant [Planetmint Transactions Spec](https://github.com/planetmint/BEPs/tree/master/13/). A CREATE transaction must be signed by all the owners. (If you're looking for that signature, @@ -120,7 +120,7 @@ of the outgoing paperclips (100). When a node is asked to check if a transaction is valid, it checks several things. We documented those things in a post on *The Planetmint Blog*: -["What is a Valid Transaction in Planetmint?"](https://blog.bigchaindb.com/what-is-a-valid-transaction-in-bigchaindb-9a1a075a9598) +["What is a Valid Transaction in Planetmint?"](https://blog.planetmint.io/what-is-a-valid-transaction-in-planetmint-9a1a075a9598) (Note: That post was about Planetmint Server v1.0.0.) ### Example Transactions diff --git a/docs/root/source/conf.py b/docs/root/source/conf.py index 24728ee..491fa3b 100644 --- a/docs/root/source/conf.py +++ b/docs/root/source/conf.py @@ -79,13 +79,13 @@ def get_old_new(url, old, new): filename = wget.download(url) rename(old, new) -get_old_new('https://raw.githubusercontent.com/bigchaindb/bigchaindb/master/CODE_OF_CONDUCT.md', +get_old_new('https://raw.githubusercontent.com/planetmint/planetmint/master/CODE_OF_CONDUCT.md', 'CODE_OF_CONDUCT.md', 'contributing/cross-project-policies/code-of-conduct.md') -get_old_new('https://raw.githubusercontent.com/bigchaindb/bigchaindb/master/RELEASE_PROCESS.md', +get_old_new('https://raw.githubusercontent.com/planetmint/planetmint/master/RELEASE_PROCESS.md', 'RELEASE_PROCESS.md', 'contributing/cross-project-policies/release-process.md') -get_old_new('https://raw.githubusercontent.com/bigchaindb/bigchaindb/master/PYTHON_STYLE_GUIDE.md', +get_old_new('https://raw.githubusercontent.com/planetmint/planetmint/master/PYTHON_STYLE_GUIDE.md', 'PYTHON_STYLE_GUIDE.md', 'contributing/cross-project-policies/python-style-guide.md') suppress_warnings = ['misc.highlighting_failure'] @@ -304,7 +304,7 @@ html_static_path = ['_static'] # html_search_scorer = 'scorer.js' # Output file base name for HTML help builder. -htmlhelp_basename = 'BigchainDBdoc' +htmlhelp_basename = 'Planetmintdoc' # -- Options for LaTeX output --------------------------------------------- @@ -372,7 +372,7 @@ latex_documents = [ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - (master_doc, 'bigchaindb', 'Planetmint Documentation', + (master_doc, 'planetmint', 'Planetmint Documentation', [author], 1) ] diff --git a/docs/root/source/contributing/cross-project-policies/code-of-conduct.md b/docs/root/source/contributing/cross-project-policies/code-of-conduct.md index 4dff95c..00cbdd1 100644 --- a/docs/root/source/contributing/cross-project-policies/code-of-conduct.md +++ b/docs/root/source/contributing/cross-project-policies/code-of-conduct.md @@ -1,6 +1,6 @@ @@ -42,7 +42,7 @@ This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Instances of abusive, harassing, or otherwise unacceptable behavior directed at yourself or another community member may be -reported by contacting a project maintainer at [contact@bigchaindb.com](mailto:contact@bigchaindb.com). All +reported by contacting a project maintainer at [contact@planetmint.io](mailto:contact@planetmint.io). All complaints will be reviewed and investigated and will result in a response that is appropriate to the circumstances. Maintainers are obligated to maintain confidentiality with regard to the reporter of an diff --git a/docs/root/source/contributing/cross-project-policies/python-style-guide.md b/docs/root/source/contributing/cross-project-policies/python-style-guide.md index 5cdb39b..65ffaf3 100644 --- a/docs/root/source/contributing/cross-project-policies/python-style-guide.md +++ b/docs/root/source/contributing/cross-project-policies/python-style-guide.md @@ -1,6 +1,6 @@ @@ -13,10 +13,10 @@ This guide starts out with our general Python coding style guidelines and ends w Our starting point is [PEP8](https://www.python.org/dev/peps/pep-0008/), the standard "Style Guide for Python Code." Many Python IDEs will check your code against PEP8. (Note that PEP8 isn't frozen; it actually changes over time, but slowly.) -BigchainDB uses Python 3.5+, so you can ignore all PEP8 guidelines specific to Python 2. +Planetmint uses Python 3.5+, so you can ignore all PEP8 guidelines specific to Python 2. We use [pre-commit](http://pre-commit.com/) to check some of the rules below before every commit but not everything is realized yet. -The hooks we use can be found in the [.pre-commit-config.yaml](https://github.com/bigchaindb/bigchaindb/blob/master/.pre-commit-config.yaml) file. +The hooks we use can be found in the [.pre-commit-config.yaml](https://github.com/planetmint/planetmint/blob/master/.pre-commit-config.yaml) file. ### Python Docstrings @@ -30,7 +30,7 @@ PEP8 says some things about docstrings, but not what to put in them or how to st PEP8 has some [maximum line length guidelines](https://www.python.org/dev/peps/pep-0008/#id17), starting with "Limit all lines to a maximum of 79 characters" but "for flowing long blocks of text with fewer structural restrictions (docstrings or comments), the line length should be limited to 72 characters." -We discussed this at length, and it seems that the consensus is: _try_ to keep line lengths less than 79/72 characters, unless you have a special situation where longer lines would improve readability. (The basic reason is that 79/72 works for everyone, and BigchainDB is an open source project.) As a hard limit, keep all lines less than 119 characters (which is the width of GitHub code review). +We discussed this at length, and it seems that the consensus is: _try_ to keep line lengths less than 79/72 characters, unless you have a special situation where longer lines would improve readability. (The basic reason is that 79/72 works for everyone, and Planetmint is an open source project.) As a hard limit, keep all lines less than 119 characters (which is the width of GitHub code review). ### Single or Double Quotes? @@ -86,12 +86,12 @@ we use the `format()` version. The [official Python documentation says](https:// We use [Flake8](http://flake8.pycqa.org/en/latest/index.html) to check our Python code style. Once you have it installed, you can run it using: ```text -flake8 --max-line-length 119 bigchaindb/ +flake8 --max-line-length 119 planetmint/ ``` ## Writing and Running (Python) Tests -The content of this section was moved to [`bigchaindb/tests/README.md`](https://github.com/bigchaindb/bigchaindb/blob/master/tests/README.md). +The content of this section was moved to [`planetmint/tests/README.md`](https://github.com/planetmint/planetmint/blob/master/tests/README.md). Note: We automatically run all tests on all pull requests (using Travis CI), so you should definitely run all tests locally before you submit a pull request. See the above-linked README file for instructions. diff --git a/docs/root/source/contributing/cross-project-policies/release-process.md b/docs/root/source/contributing/cross-project-policies/release-process.md index 84e1924..4e032da 100644 --- a/docs/root/source/contributing/cross-project-policies/release-process.md +++ b/docs/root/source/contributing/cross-project-policies/release-process.md @@ -1,6 +1,6 @@ @@ -9,7 +9,7 @@ Code is Apache-2.0 and docs are CC-BY-4.0 ## Notes -BigchainDB follows +Planetmint follows [the Python form of Semantic Versioning](https://packaging.python.org/tutorials/distributing-packages/#choosing-a-versioning-scheme) (i.e. MAJOR.MINOR.PATCH), which is almost identical @@ -25,9 +25,9 @@ to [regular semantic versioning](http://semver.org/), but there's no hyphen, e.g We use `0.9` and `0.9.0` as example version and short-version values below. You should replace those with the correct values for your new version. -We follow [BEP-1](https://github.com/bigchaindb/BEPs/tree/master/1), which is our variant of C4, the Collective Code Construction Contract, so a release is just a [tagged commit](https://git-scm.com/book/en/v2/Git-Basics-Tagging) on the `master` branch, i.e. a label for a particular Git commit. +We follow [BEP-1](https://github.com/planetmint/BEPs/tree/master/1), which is our variant of C4, the Collective Code Construction Contract, so a release is just a [tagged commit](https://git-scm.com/book/en/v2/Git-Basics-Tagging) on the `master` branch, i.e. a label for a particular Git commit. -The following steps are what we do to release a new version of _BigchainDB Server_. The steps to release the Python Driver are similar but not the same. +The following steps are what we do to release a new version of _Planetmint Server_. The steps to release the Python Driver are similar but not the same. ## Steps @@ -37,21 +37,21 @@ The following steps are what we do to release a new version of _BigchainDB Serve - Update all Docker image tags in all Kubernetes YAML files (in the `k8s/` directory). For example, in the files: - - `k8s/bigchaindb/bigchaindb-ss.yaml` and - - `k8s/dev-setup/bigchaindb.yaml` + - `k8s/planetmint/planetmint-ss.yaml` and + - `k8s/dev-setup/planetmint.yaml` - find the line of the form `image: bigchaindb/bigchaindb:0.8.1` and change the version number to the new version number, e.g. `0.9.0`. (This is the Docker image that Kubernetes should pull from Docker Hub.) + find the line of the form `image: planetmint/planetmint:0.8.1` and change the version number to the new version number, e.g. `0.9.0`. (This is the Docker image that Kubernetes should pull from Docker Hub.) Keep in mind that this is a _Docker image tag_ so our naming convention is a bit different; see Note 2 in the **Notes** section above. - - In `bigchaindb/version.py`: + - In `planetmint/version.py`: - update `__version__` to e.g. `0.9.0` (with no `.dev` on the end) - update `__short_version__` to e.g. `0.9` (with no `.dev` on the end) - - In the docs about installing BigchainDB (and Tendermint), and in the associated scripts, recommend/install a version of Tendermint that _actually works_ with the soon-to-be-released version of BigchainDB. You can find all such references by doing a search for the previously-recommended version number, such as `0.31.5`. + - In the docs about installing Planetmint (and Tendermint), and in the associated scripts, recommend/install a version of Tendermint that _actually works_ with the soon-to-be-released version of Planetmint. You can find all such references by doing a search for the previously-recommended version number, such as `0.31.5`. - In `setup.py`, _maybe_ update the development status item in the `classifiers` list. For example, one allowed value is `"Development Status :: 5 - Production/Stable"`. The [allowed values are listed at pypi.python.org](https://pypi.python.org/pypi?%3Aaction=list_classifiers). 2. **Wait for all the tests to pass!** 3. Merge the pull request into the `master` branch. -4. Go to the [bigchaindb/bigchaindb Releases page on GitHub](https://github.com/bigchaindb/bigchaindb/releases) +4. Go to the [planetmint/planetmint Releases page on GitHub](https://github.com/planetmint/planetmint/releases) and click the "Draft a new release" button. 5. Fill in the details: - **Tag version:** version number preceded by `v`, e.g. `v0.9.1` @@ -59,13 +59,13 @@ The following steps are what we do to release a new version of _BigchainDB Serve - **Title:** Same as tag version above, e.g `v0.9.1` - **Description:** The body of the changelog entry (Added, Changed, etc.) 6. Click "Publish release" to publish the release on GitHub. -7. On your local computer, make sure you're on the `master` branch and that it's up-to-date with the `master` branch in the bigchaindb/bigchaindb repository (e.g. `git pull upstream master`). We're going to use that to push a new `bigchaindb` package to PyPI. +7. On your local computer, make sure you're on the `master` branch and that it's up-to-date with the `master` branch in the planetmint/planetmint repository (e.g. `git pull upstream master`). We're going to use that to push a new `planetmint` package to PyPI. 8. Make sure you have a `~/.pypirc` file containing credentials for PyPI. -9. Do `make release` to build and publish the new `bigchaindb` package on PyPI. For this step you need to have `twine` installed. If you get an error like `Makefile:135: recipe for target 'clean-pyc' failed` then try doing +9. Do `make release` to build and publish the new `planetmint` package on PyPI. For this step you need to have `twine` installed. If you get an error like `Makefile:135: recipe for target 'clean-pyc' failed` then try doing ```text sudo chown -R $(whoami):$(whoami) . ``` -10. [Log in to readthedocs.org](https://readthedocs.org/accounts/login/) and go to the **BigchainDB Server** project, then: +10. [Log in to readthedocs.org](https://readthedocs.org/accounts/login/) and go to the **Planetmint Server** project, then: - Click on "Builds", select "latest" from the drop-down menu, then click the "Build Version:" button. - Wait for the build of "latest" to finish. This can take a few minutes. - Go to Admin --> Advanced Settings @@ -80,8 +80,8 @@ The following steps are what we do to release a new version of _BigchainDB Serve 3. Scroll to the bottom of the page and click "Save". 11. Go to [Docker Hub](https://hub.docker.com/) and sign in, then: - Click on "Organizations" - - Click on "bigchaindb" - - Click on "bigchaindb/bigchaindb" + - Click on "planetmint" + - Click on "planetmint/planetmint" - Click on "Build Settings" - Find the row where "Docker Tag Name" equals `latest` and change the value of "Name" to the name (Git tag) @@ -98,4 +98,4 @@ The following steps are what we do to release a new version of _BigchainDB Serve - If the release is an Alpha, Beta or Release Candidate release, then click on the "Trigger" button for that tag as well. -Congratulations, you have released a new version of BigchainDB Server! +Congratulations, you have released a new version of Planetmint Server! diff --git a/docs/root/source/contributing/dev-setup-coding-and-contribution-process/run-dev-network-ansible.md b/docs/root/source/contributing/dev-setup-coding-and-contribution-process/run-dev-network-ansible.md index f98685f..7222ac5 100644 --- a/docs/root/source/contributing/dev-setup-coding-and-contribution-process/run-dev-network-ansible.md +++ b/docs/root/source/contributing/dev-setup-coding-and-contribution-process/run-dev-network-ansible.md @@ -25,7 +25,7 @@ Minimum resource requirements for a single node Planetmint dev setup. **The more ## Clone the Planetmint repository ```text -$ git clone https://github.com/bigchaindb/bigchaindb.git +$ git clone https://github.com/planetmint/planetmint.git ``` ## Install dependencies @@ -33,28 +33,28 @@ $ git clone https://github.com/bigchaindb/bigchaindb.git You can also install `ansible` and other dependencies, if any, using the `boostrap.sh` script inside the Planetmint repository. -Navigate to `bigchaindb/pkg/scripts` and run the `bootstrap.sh` script to install the dependencies +Navigate to `planetmint/pkg/scripts` and run the `bootstrap.sh` script to install the dependencies for your OS. The script also checks if the OS you are running is compatible with the supported versions. **Note**: `bootstrap.sh` only supports Ubuntu >= 16.04, CentOS >= 7 and Fedora >=24 and MacOSX. ```text -$ cd bigchaindb/pkg/scripts/ +$ cd planetmint/pkg/scripts/ $ bash bootstrap.sh --operation install ``` ### Planetmint Setup Configuration(s) #### Local Setup -You can run the Ansible playbook `bigchaindb-start.yml` on your local dev machine and set up the Planetmint node where +You can run the Ansible playbook `planetmint-start.yml` on your local dev machine and set up the Planetmint node where Planetmint can be run as a process or inside a Docker container(s) depending on your configuration. Before, running the playbook locally, you need to update the `hosts` and `stack-config.yml` configuration, which will notify Ansible that we need to run the play locally. ##### Update Hosts -Navigate to `bigchaindb/pkg/configuration/hosts` inside the Planetmint repository. +Navigate to `planetmint/pkg/configuration/hosts` inside the Planetmint repository. ```text -$ cd bigchaindb/pkg/configuration/hosts +$ cd planetmint/pkg/configuration/hosts ``` Edit `all` configuration file: @@ -64,9 +64,9 @@ Edit `all` configuration file: ansible_connection=local ``` ##### Update Configuration -Navigate to `bigchaindb/pkg/configuration/vars` inside the Planetmint repository. +Navigate to `planetmint/pkg/configuration/vars` inside the Planetmint repository. ```text -$ cd bigchaindb/pkg/configuration/vars/stack-config.yml +$ cd planetmint/pkg/configuration/vars/stack-config.yml ``` Edit `bdb-config.yml` configuration file as per your requirements, sample configuration file(s): @@ -84,30 +84,30 @@ stack_type: "1" ``` ### Planetmint Setup -Now, You can safely run the `bigchaindb-start.yml` playbook and everything will be taken care of by `Ansible`. To run the playbook please navigate to the `bigchaindb/pkg/configuration` directory inside the Planetmint repository and run the `bigchaindb-start.yml` playbook. +Now, You can safely run the `planetmint-start.yml` playbook and everything will be taken care of by `Ansible`. To run the playbook please navigate to the `planetmint/pkg/configuration` directory inside the Planetmint repository and run the `planetmint-start.yml` playbook. ```text -$ cd bigchaindb/pkg/configuration/ +$ cd planetmint/pkg/configuration/ -$ ansible-playbook bigchaindb-start.yml -i hosts/all --extra-vars "operation=start home_path=$(pwd)" +$ ansible-playbook planetmint-start.yml -i hosts/all --extra-vars "operation=start home_path=$(pwd)" ``` After successful execution of the playbook, you can verify that Planetmint docker(s)/process(es) is(are) running. Verify Planetmint process(es): ```text -$ ps -ef | grep bigchaindb +$ ps -ef | grep planetmint ``` OR Verify Planetmint Docker(s): ```text -$ docker ps | grep bigchaindb +$ docker ps | grep planetmint ``` You can now send transactions and verify the functionality of your Planetmint node. -See the [Planetmint Python Driver documentation](https://docs.bigchaindb.com/projects/py-driver/en/latest/index.html) +See the [Planetmint Python Driver documentation](https://docs.planetmint.io/projects/py-driver/en/latest/index.html) for details on how to use it. **Note**: The `bdb_root_url` can be be one of the following: @@ -121,19 +121,19 @@ OR bdb_root_url = http://: ``` -**Note**: Planetmint has [other drivers as well](http://docs.bigchaindb.com/projects/server/en/latest/drivers-clients/index.html). +**Note**: Planetmint has [other drivers as well](http://docs.planetmint.io/projects/server/en/latest/drivers-clients/index.html). ### Experimental: Running Ansible a Remote Dev/Host #### Remote Setup -You can also run the Ansible playbook `bigchaindb-start.yml` on remote machine(s) and set up the Planetmint node where +You can also run the Ansible playbook `planetmint-start.yml` on remote machine(s) and set up the Planetmint node where Planetmint can run as a process or inside a Docker container(s) depending on your configuration. Before, running the playbook on a remote host, you need to update the `hosts` and `stack-config.yml` configuration, which will notify Ansible that we need to run the play on a remote host. ##### Update Remote Hosts -Navigate to `bigchaindb/pkg/configuration/hosts` inside the Planetmint repository. +Navigate to `planetmint/pkg/configuration/hosts` inside the Planetmint repository. ```text -$ cd bigchaindb/pkg/configuration/hosts +$ cd planetmint/pkg/configuration/hosts ``` Edit `all` configuration file: @@ -148,9 +148,9 @@ Edit `all` configuration file: please consult [Ansible Documentation](http://docs.ansible.com/ansible/latest/intro_getting_started.html). ##### Update Remote Configuration -Navigate to `bigchaindb/pkg/configuration/vars` inside the Planetmint repository. +Navigate to `planetmint/pkg/configuration/vars` inside the Planetmint repository. ```text -$ cd bigchaindb/pkg/configuration/vars/stack-config.yml +$ cd planetmint/pkg/configuration/vars/stack-config.yml ``` Edit `stack-config.yml` configuration file as per your requirements, sample configuration file(s): @@ -167,4 +167,4 @@ stack_type: "local" stack_type: "1" ``` -After, the configuration of remote hosts, [run the Ansible playbook and verify your deployment](#bigchaindb-setup-ansible). +After, the configuration of remote hosts, [run the Ansible playbook and verify your deployment](#planetmint-setup-ansible). diff --git a/docs/root/source/contributing/dev-setup-coding-and-contribution-process/run-dev-network-stack.md b/docs/root/source/contributing/dev-setup-coding-and-contribution-process/run-dev-network-stack.md index 8b2e7b6..e5e9c37 100644 --- a/docs/root/source/contributing/dev-setup-coding-and-contribution-process/run-dev-network-stack.md +++ b/docs/root/source/contributing/dev-setup-coding-and-contribution-process/run-dev-network-stack.md @@ -26,20 +26,20 @@ Minimum resource requirements for a single node Planetmint dev setup. **The more ## Download the scripts > **Note**: If you're working on Planetmint Server code, on a branch based on > recent code, then you already have local recent versions of *stack.sh* and -> *unstack.sh* in your bigchaindb/pkg/scripts/ directory. Otherwise you can +> *unstack.sh* in your planetmint/pkg/scripts/ directory. Otherwise you can > get them using: ```text $ export GIT_BRANCH=master -$ curl -fOL https://raw.githubusercontent.com/bigchaindb/bigchaindb/${GIT_BRANCH}/pkg/scripts/stack.sh +$ curl -fOL https://raw.githubusercontent.com/planetmint/planetmint/${GIT_BRANCH}/pkg/scripts/stack.sh # Optional -$ curl -fOL https://raw.githubusercontent.com/bigchaindb/bigchaindb/${GIT_BRANCH}/pkg/scripts/unstack.sh +$ curl -fOL https://raw.githubusercontent.com/planetmint/planetmint/${GIT_BRANCH}/pkg/scripts/unstack.sh ``` ## Quick Start If you run `stack.sh` out of the box i.e. without any configuration changes, you will be able to deploy a 4 node -Planetmint network with Docker containers, created from `master` branch of `bigchaindb/bigchaindb` repo and Tendermint version `0.22.8`. +Planetmint network with Docker containers, created from `master` branch of `planetmint/planetmint` repo and Tendermint version `0.22.8`. **Note**: Run `stack.sh` with either root or non-root user with sudo enabled. @@ -89,11 +89,11 @@ $ bash stack.sh -h of the instance(s) spawned. (default: ubuntu/xenial64) ENV[STACK_REPO] - (Optional) To configure bigchaindb repo to use, set STACK_REPO environment - variable. (default: bigchaindb/bigchaindb) + (Optional) To configure planetmint repo to use, set STACK_REPO environment + variable. (default: planetmint/planetmint) ENV[STACK_BRANCH] - (Optional) To configure bigchaindb repo branch to use set STACK_BRANCH environment + (Optional) To configure planetmint repo branch to use set STACK_BRANCH environment variable. (default: master) ENV[TM_VERSION] @@ -171,8 +171,8 @@ $ export STACK_SIZE=4 $ export STACK_TYPE=docker #Optional, repo to use for the network deployment -# Default: bigchaindb/bigchaindb -$ export STACK_REPO=bigchaindb/bigchaindb +# Default: planetmint/planetmint +$ export STACK_REPO=planetmint/planetmint #Optional, codebase to use for the network deployment # Default: master @@ -222,8 +222,8 @@ $ export STACK_VM_CPUS=1 $ export STACK_BOX_NAME=ubuntu/xenial64 #Optional, repo to use for the network deployment -# Default: bigchaindb/bigchaindb -$ export STACK_REPO=bigchaindb/bigchaindb +# Default: planetmint/planetmint +$ export STACK_REPO=planetmint/planetmint #Optional, codebase to use for the network deployment # Default: master diff --git a/docs/root/source/contributing/dev-setup-coding-and-contribution-process/run-node-as-processes.md b/docs/root/source/contributing/dev-setup-coding-and-contribution-process/run-node-as-processes.md index 82b8bbb..70a3791 100644 --- a/docs/root/source/contributing/dev-setup-coding-and-contribution-process/run-node-as-processes.md +++ b/docs/root/source/contributing/dev-setup-coding-and-contribution-process/run-node-as-processes.md @@ -70,7 +70,7 @@ The commands are: export PATH=${PATH}:${GOPATH}/bin ``` -Follow [the Tendermint docs](https://tendermint.com/docs/introduction/install.html#from-source) to install Tendermint from source. +Follow [the Tendermint docs](https://tendermint.io/docs/introduction/install.html#from-source) to install Tendermint from source. If the installation is successful then Tendermint is installed at `$GOPATH/bin`. To ensure Tendermint's installed fine execute the following command, @@ -112,8 +112,8 @@ $ tendermint unsafe_reset_all To install Planetmint from source (for dev), clone the repo and execute the following command, (it is better that you create a virtual env for this) ```bash -$ git clone https://github.com/bigchaindb/bigchaindb.git -$ cd bigchaindb +$ git clone https://github.com/planetmint/planetmint.git +$ cd planetmint $ pip install -e .[dev] # or pip install -e '.[dev]' # for zsh ``` @@ -132,7 +132,7 @@ One could mark a specific test and execute the same by appending `-m my_mark` to Although the above should prove sufficient in most cases but in case tests are failing on Travis CI then the following command can be used to possibly replicate the failure locally, ```bash -$ docker-compose run --rm --no-deps bdb pytest -v --cov=bigchaindb +$ docker-compose run --rm --no-deps bdb pytest -v --cov=planetmint ``` NOTE: before executing the above command the user must ensure that they reset the Tendermint container by executing `tendermint usafe_reset_all` command in the Tendermint container. diff --git a/docs/root/source/contributing/dev-setup-coding-and-contribution-process/run-node-with-docker-compose.md b/docs/root/source/contributing/dev-setup-coding-and-contribution-process/run-node-with-docker-compose.md index 4f85ad2..5ee7643 100644 --- a/docs/root/source/contributing/dev-setup-coding-and-contribution-process/run-node-with-docker-compose.md +++ b/docs/root/source/contributing/dev-setup-coding-and-contribution-process/run-node-with-docker-compose.md @@ -33,7 +33,7 @@ There are also other commands you can execute: The Planetmint `Makefile` is a wrapper around some `docker-compose` commands we use frequently. If you need a finer granularity to manage the containers, you can still use `docker-compose` directly. This part of the documentation explains how to do that. ```bash -$ docker-compose build bigchaindb +$ docker-compose build planetmint $ docker-compose up -d bdb ``` @@ -41,7 +41,7 @@ The above command will launch all 3 main required services/processes: * ``mongodb`` * ``tendermint`` -* ``bigchaindb`` +* ``planetmint`` To follow the logs of the ``tendermint`` service: @@ -49,10 +49,10 @@ To follow the logs of the ``tendermint`` service: $ docker-compose logs -f tendermint ``` -To follow the logs of the ``bigchaindb`` service: +To follow the logs of the ``planetmint`` service: ```bash -$ docker-compose logs -f bigchaindb +$ docker-compose logs -f planetmint ``` To follow the logs of the ``mongodb`` service: @@ -81,18 +81,18 @@ $ docker-compose -f docker-compose.yml run --rm bdb-driver ipython Run all the tests using: ```bash -$ docker-compose run --rm --no-deps bigchaindb pytest -v +$ docker-compose run --rm --no-deps planetmint pytest -v ``` Run tests from a file: ```bash -$ docker-compose run --rm --no-deps bigchaindb pytest /path/to/file -v +$ docker-compose run --rm --no-deps planetmint pytest /path/to/file -v ``` Run specific tests: ```bash -$ docker-compose run --rm --no-deps bigchaindb pytest /path/to/file -k "" -v +$ docker-compose run --rm --no-deps planetmint pytest /path/to/file -k "" -v ``` ### Building Docs diff --git a/docs/root/source/contributing/dev-setup-coding-and-contribution-process/write-code.rst b/docs/root/source/contributing/dev-setup-coding-and-contribution-process/write-code.rst index ada8bbf..2d6a80f 100644 --- a/docs/root/source/contributing/dev-setup-coding-and-contribution-process/write-code.rst +++ b/docs/root/source/contributing/dev-setup-coding-and-contribution-process/write-code.rst @@ -21,7 +21,7 @@ Refresh Yourself about the C4 Process ------------------------------------- C4 is the Collective Code Construction Contract. It's quite short: -`re-reading it will only take a few minutes `_. +`re-reading it will only take a few minutes `_. Set Up Your Local Machine. Here's How. @@ -69,7 +69,7 @@ Set Up Your Local Machine. Here's How. Before You Start Writing Code ----------------------------- -Read `BEP-24 `_ +Read `BEP-24 `_ so you know what to do to ensure that your changes (i.e. your future pull request) can be merged. It's easy and will save you some hassle later on. @@ -79,7 +79,7 @@ Start Writing Code Use the Git `Fork and Pull Request Workflow `_. Tip: You could print that page for reference. -Your Python code should follow `our Python Style Guide `_. +Your Python code should follow `our Python Style Guide `_. Similarly for JavaScript. Make sure `pre-commit `_ actually checks commits. Do: diff --git a/docs/root/source/contributing/ways-to-contribute/report-a-bug.md b/docs/root/source/contributing/ways-to-contribute/report-a-bug.md index 7f5fbe9..9d3c37a 100644 --- a/docs/root/source/contributing/ways-to-contribute/report-a-bug.md +++ b/docs/root/source/contributing/ways-to-contribute/report-a-bug.md @@ -21,10 +21,10 @@ To write an issue, go to the relevant GitHub repository, click on the **Issues** People ask questions about Planetmint in the following places: - Gitter - - [bigchaindb/bigchaindb](https://gitter.im/planetmint/community) - - [bigchaindb/js-bigchaindb-driver](https://gitter.im/planetmint/community)) + - [planetmint/planetmint](https://gitter.im/planetmint/community) + - [planetmint/js-planetmint-driver](https://gitter.im/planetmint/community)) - [Twitter](https://twitter.com/planetmint) -- [Stack Overflow "bigchaindb"](https://stackoverflow.com/search?q=planetmint) +- [Stack Overflow "planetmint"](https://stackoverflow.com/search?q=planetmint) Feel free to hang out and answer some questions. People will be thankful. diff --git a/docs/root/source/drivers/index.rst b/docs/root/source/drivers/index.rst index de99da7..224230c 100644 --- a/docs/root/source/drivers/index.rst +++ b/docs/root/source/drivers/index.rst @@ -11,9 +11,9 @@ Connectors to Planetmint are referred to as drivers within the community. A driv These drivers were originally created by the original Planetmint team: -* `Python Driver `_ -* `JavaScript / Node.js Driver `_ -* `Java Driver `_ +* `Python Driver `_ +* `JavaScript / Node.js Driver `_ +* `Java Driver `_ These drivers and tools were created by the Planetmint community: @@ -23,9 +23,9 @@ These drivers and tools were created by the Planetmint community: but may still be useful. Others might not work with the latest version of Planetmint. -* `ANSI C driver `_, should also work with C++ (working as of June 2019) -* `C# driver `_ (working as of May 2019) -* `Haskell transaction builder `_ -* `Go driver `_ -* `Ruby driver `_ -* `Ruby library for preparing/signing transactions and submitting them or querying a Planetmint node (MIT licensed) `_ +* `ANSI C driver `_, should also work with C++ (working as of June 2019) +* `C# driver `_ (working as of May 2019) +* `Haskell transaction builder `_ +* `Go driver `_ +* `Ruby driver `_ +* `Ruby library for preparing/signing transactions and submitting them or querying a Planetmint node (MIT licensed) `_ diff --git a/docs/root/source/index.rst b/docs/root/source/index.rst index 36bb193..5a013c8 100644 --- a/docs/root/source/index.rst +++ b/docs/root/source/index.rst @@ -21,7 +21,7 @@ More About Planetmint :maxdepth: 1 Planetmint Docs Home - about-bigchaindb + about-planetmint terminology properties basic-usage diff --git a/docs/root/source/installation/api/http-client-server-api.rst b/docs/root/source/installation/api/http-client-server-api.rst index c80d515..528d240 100644 --- a/docs/root/source/installation/api/http-client-server-api.rst +++ b/docs/root/source/installation/api/http-client-server-api.rst @@ -18,7 +18,7 @@ If you set up a Planetmint node or reverse proxy yourself, and you're not sure what the API Root URL is, then see the last section of this page for help. -.. _bigchaindb-root-url: +.. _planetmint-root-url: Planetmint Root URL ------------------- @@ -59,7 +59,7 @@ Transactions Endpoint then one option is to connect to MongoDB directly (if possible) and do whatever queries MongoDB allows. For more about that option, see - `the page about querying Planetmint `_. + `the page about querying Planetmint `_. .. http:get:: /api/v1/transactions/{transaction_id} @@ -147,11 +147,11 @@ Transactions Endpoint If it's invalid, the node will return an HTTP 400 (error). Otherwise, the node will send the transaction to Tendermint (in the same node) using the `Tendermint broadcast API - `_. + `_. The meaning of the ``mode`` query parameter is inherited from the mode parameter in `Tendermint's broadcast API - `_. + `_. ``mode=async`` means the HTTP response will come back immediately, before Tendermint asks Planetmint Server to check the validity of the transaction (a second time). ``mode=sync`` means the HTTP response will come back @@ -172,11 +172,11 @@ Transactions Endpoint The posted transaction should be valid. The relevant - `Planetmint Transactions Spec `_ + `Planetmint Transactions Spec `_ explains how to build a valid transaction and how to check if a transaction is valid. One would normally use a driver such as the `Planetmint Python Driver - `_ + `_ to build a valid transaction. .. note:: @@ -223,7 +223,7 @@ unspent outputs. then one option is to connect to MongoDB directly (if possible) and do whatever queries MongoDB allows. For more about that option, see - `the page about querying Planetmint `_. + `the page about querying Planetmint `_. .. http:get:: /api/v1/outputs @@ -341,7 +341,7 @@ Assets then one option is to connect to MongoDB directly (if possible) and do whatever queries MongoDB allows. For more about that option, see - `the page about querying Planetmint `_. + `the page about querying Planetmint `_. .. http:get:: /api/v1/assets @@ -377,7 +377,7 @@ Assets .. sourcecode:: http - GET /api/v1/assets/?search=bigchaindb HTTP/1.1 + GET /api/v1/assets/?search=planetmint HTTP/1.1 Host: example.com **Example response**: @@ -426,7 +426,7 @@ Assets .. sourcecode:: http - GET /api/v1/assets?search=bigchaindb&limit=2 HTTP/1.1 + GET /api/v1/assets?search=planetmint&limit=2 HTTP/1.1 Host: example.com **Example response**: @@ -465,7 +465,7 @@ Transaction Metadata then one option is to connect to MongoDB directly (if possible) and do whatever queries MongoDB allows. For more about that option, see - `the page about querying Planetmint `_. + `the page about querying Planetmint `_. .. http:get:: /api/v1/metadata @@ -501,7 +501,7 @@ Transaction Metadata .. sourcecode:: http - GET /api/v1/metadata/?search=bigchaindb HTTP/1.1 + GET /api/v1/metadata/?search=planetmint HTTP/1.1 Host: example.com **Example response**: @@ -550,7 +550,7 @@ Transaction Metadata .. sourcecode:: http - GET /api/v1/metadata?search=bigchaindb&limit=2 HTTP/1.1 + GET /api/v1/metadata?search=planetmint&limit=2 HTTP/1.1 Host: example.com **Example response**: @@ -703,7 +703,7 @@ Blocks Determining the API Root URL ---------------------------- -When you start Planetmint Server using ``bigchaindb start``, +When you start Planetmint Server using ``planetmint start``, an HTTP API is exposed at some address. The default is: ``http://localhost:9984/api/v1/`` diff --git a/docs/root/source/installation/api/http-samples/api-index-response.http b/docs/root/source/installation/api/http-samples/api-index-response.http index 376552b..77a145c 100644 --- a/docs/root/source/installation/api/http-samples/api-index-response.http +++ b/docs/root/source/installation/api/http-samples/api-index-response.http @@ -4,7 +4,7 @@ Content-Type: application/json { "assets": "/assets/", "blocks": "/blocks/", - "docs": "https://docs.bigchaindb.com/projects/server/en/v0.9.0/http-client-server-api.html", + "docs": "https://docs.planetmint.io/projects/server/en/v0.9.0/http-client-server-api.html", "metadata": "/metadata/", "outputs": "/outputs/", "streams": "ws://localhost:9985/api/v1/streams/valid_transactions", diff --git a/docs/root/source/installation/api/http-samples/index-response.http b/docs/root/source/installation/api/http-samples/index-response.http index c087059..d4ec60d 100644 --- a/docs/root/source/installation/api/http-samples/index-response.http +++ b/docs/root/source/installation/api/http-samples/index-response.http @@ -6,7 +6,7 @@ Content-Type: application/json "v1": { "assets": "/api/v1/assets/", "blocks": "/api/v1/blocks/", - "docs": "https://docs.bigchaindb.com/projects/server/en/v0.9.0/http-client-server-api.html", + "docs": "https://docs.planetmint.io/projects/server/en/v0.9.0/http-client-server-api.html", "metadata": "/api/v1/metadata/", "outputs": "/api/v1/outputs/", "streams": "ws://localhost:9985/api/v1/streams/valid_transactions", @@ -14,7 +14,7 @@ Content-Type: application/json "validators": "/api/v1/validators" } }, - "docs": "https://docs.bigchaindb.com/projects/server/en/v0.9.0/", + "docs": "https://docs.planetmint.io/projects/server/en/v0.9.0/", "software": "Planetmint", "version": "0.9.0" } diff --git a/docs/root/source/installation/api/websocket-event-stream-api.rst b/docs/root/source/installation/api/websocket-event-stream-api.rst index 0978f4c..96eab15 100644 --- a/docs/root/source/installation/api/websocket-event-stream-api.rst +++ b/docs/root/source/installation/api/websocket-event-stream-api.rst @@ -82,7 +82,7 @@ All messages sent in a stream are in the JSON format. as a specific ``output``'s ``public_key``. If you have specific use cases that you think would fit as part of this - API, consider creating a new `BEP `_. + API, consider creating a new `BEP `_. Valid Transactions ~~~~~~~~~~~~~~~~~~ diff --git a/docs/root/source/installation/appendices/cryptography.rst b/docs/root/source/installation/appendices/cryptography.rst index 2416089..937eaa6 100644 --- a/docs/root/source/installation/appendices/cryptography.rst +++ b/docs/root/source/installation/appendices/cryptography.rst @@ -9,6 +9,6 @@ Cryptography Use the following link to find the Planetmint Transactions Spec (or Specs) that are relevant to you: -`Planetmint Transactions Specs `_ +`Planetmint Transactions Specs `_ Then see the sections titled **Cryptographic Hashes** and **Cryptographic Keys and Signatures**. \ No newline at end of file diff --git a/docs/root/source/installation/appendices/licenses.md b/docs/root/source/installation/appendices/licenses.md index 3a3b5e8..13295dc 100644 --- a/docs/root/source/installation/appendices/licenses.md +++ b/docs/root/source/installation/appendices/licenses.md @@ -7,4 +7,4 @@ Code is Apache-2.0 and docs are CC-BY-4.0 # Licenses -Information about how the Planetmint Server code and documentation are licensed can be found in [the LICENSES.md file](https://github.com/bigchaindb/bigchaindb/blob/master/LICENSES.md) of the bigchaindb/bigchaindb repository on GitHub. +Information about how the Planetmint Server code and documentation are licensed can be found in [the LICENSES.md file](https://github.com/planetmint/planetmint/blob/master/LICENSES.md) of the planetmint/planetmint repository on GitHub. diff --git a/docs/root/source/installation/appendices/log-rotation.md b/docs/root/source/installation/appendices/log-rotation.md index 0f453c2..53bea64 100644 --- a/docs/root/source/installation/appendices/log-rotation.md +++ b/docs/root/source/installation/appendices/log-rotation.md @@ -27,8 +27,8 @@ and [log rotation](https://docs.mongodb.com/v3.6/tutorial/rotate-log-files/). Planetmint Server writes its logs to two files: normal logs and error logs. The names of those files, and their locations, are set as part of the Planetmint configuration settings. The default names and locations are: -- `~/bigchaindb.log` -- `~/bigchaindb-errors.log` +- `~/planetmint.log` +- `~/planetmint-errors.log` Log rotation is baked into Planetmint Server using Python's `logging` module. The logs for Planetmint Server are rotated when any of the above mentioned files exceeds 209715200 bytes (i.e. approximately 209 MB). @@ -43,7 +43,7 @@ Tendermint writes its logs to the files: If you started Planetmint Server and Tendermint using Monit, as suggested by our guide on [How to Set Up a Planetmint Network](../network-setup/network-setup), -then the logs will be written to `$HOME/.bigchaindb-monit/logs/`. +then the logs will be written to `$HOME/.planetmint-monit/logs/`. Moreover, if you started Planetmint Server and Tendermint using Monit, then Monit monitors the Tendermint log files. diff --git a/docs/root/source/installation/commands-and-backend/backend.rst b/docs/root/source/installation/commands-and-backend/backend.rst index 1877d80..543520d 100644 --- a/docs/root/source/installation/commands-and-backend/backend.rst +++ b/docs/root/source/installation/commands-and-backend/backend.rst @@ -8,46 +8,46 @@ Database Backend Interfaces ########################### -.. automodule:: bigchaindb.backend +.. automodule:: planetmint.backend :special-members: __init__ Generic Interfaces ================== -:mod:`bigchaindb.backend.connection` +:mod:`planetmint.backend.connection` ------------------------------------ -.. automodule:: bigchaindb.backend.connection +.. automodule:: planetmint.backend.connection :special-members: __init__ -:mod:`bigchaindb.backend.query` +:mod:`planetmint.backend.query` ------------------------------- -.. automodule:: bigchaindb.backend.query +.. automodule:: planetmint.backend.query -:mod:`bigchaindb.backend.schema` +:mod:`planetmint.backend.schema` -------------------------------- -.. automodule:: bigchaindb.backend.schema +.. automodule:: planetmint.backend.schema -:mod:`bigchaindb.backend.utils` +:mod:`planetmint.backend.utils` ------------------------------- -.. automodule:: bigchaindb.backend.utils +.. automodule:: planetmint.backend.utils MongoDB Backend =============== -.. automodule:: bigchaindb.backend.localmongodb +.. automodule:: planetmint.backend.localmongodb :special-members: __init__ -:mod:`bigchaindb.backend.localmongodb.connection` +:mod:`planetmint.backend.localmongodb.connection` ------------------------------------------------- -.. automodule:: bigchaindb.backend.localmongodb.connection +.. automodule:: planetmint.backend.localmongodb.connection -:mod:`bigchaindb.backend.localmongodb.query` +:mod:`planetmint.backend.localmongodb.query` -------------------------------------------- -.. automodule:: bigchaindb.backend.localmongodb.query +.. automodule:: planetmint.backend.localmongodb.query -:mod:`bigchaindb.backend.localmongodb.schema` +:mod:`planetmint.backend.localmongodb.schema` --------------------------------------------- -.. automodule:: bigchaindb.backend.localmongodb.schema +.. automodule:: planetmint.backend.localmongodb.schema diff --git a/docs/root/source/installation/commands-and-backend/commands.rst b/docs/root/source/installation/commands-and-backend/commands.rst index 11b76e8..448ec4b 100644 --- a/docs/root/source/installation/commands-and-backend/commands.rst +++ b/docs/root/source/installation/commands-and-backend/commands.rst @@ -8,17 +8,17 @@ Command Line Interface ###################### -.. automodule:: bigchaindb.commands +.. automodule:: planetmint.iomands :special-members: __init__ -:mod:`bigchaindb.commands.bigchaindb` +:mod:`planetmint.iomands.planetmint` ------------------------------------- -.. automodule:: bigchaindb.commands.bigchaindb +.. automodule:: planetmint.iomands.planetmint -:mod:`bigchaindb.commands.utils` +:mod:`planetmint.iomands.utils` -------------------------------- -.. automodule:: bigchaindb.commands.utils +.. automodule:: planetmint.iomands.utils diff --git a/docs/root/source/installation/commands-and-backend/index.rst b/docs/root/source/installation/commands-and-backend/index.rst index bc2e927..723ec25 100644 --- a/docs/root/source/installation/commands-and-backend/index.rst +++ b/docs/root/source/installation/commands-and-backend/index.rst @@ -20,7 +20,7 @@ in the Planetmint Server code, based on Python docstrings in the code itself. :maxdepth: 1 commands - the-bigchaindb-class + the-planetmint-class backend \ No newline at end of file diff --git a/docs/root/source/installation/commands-and-backend/the-bigchaindb-class.rst b/docs/root/source/installation/commands-and-backend/the-bigchaindb-class.rst index ac549c7..c012281 100644 --- a/docs/root/source/installation/commands-and-backend/the-bigchaindb-class.rst +++ b/docs/root/source/installation/commands-and-backend/the-bigchaindb-class.rst @@ -8,4 +8,4 @@ The Planetmint Class #################### -.. autoclass:: bigchaindb.Planetmint +.. autoclass:: planetmint.Planetmint diff --git a/docs/root/source/installation/network-setup/bigchaindb-node-ansible.md b/docs/root/source/installation/network-setup/bigchaindb-node-ansible.md index 186be68..f9fc9a5 100644 --- a/docs/root/source/installation/network-setup/bigchaindb-node-ansible.md +++ b/docs/root/source/installation/network-setup/bigchaindb-node-ansible.md @@ -2,6 +2,6 @@ You can find one of the installation methods with Ansible on GitHub at: -[Ansible script](https://github.com/bigchaindb/bigchaindb-node-ansible) +[Ansible script](https://github.com/planetmint/planetmint-node-ansible) It allows to install Planetmint, MongoDB, Tendermint, and python, and then connect nodes into a network. Current tested machine is Ubuntu 18.04. \ No newline at end of file diff --git a/docs/root/source/installation/network-setup/index.rst b/docs/root/source/installation/network-setup/index.rst index ffc7659..e21f5f9 100644 --- a/docs/root/source/installation/network-setup/index.rst +++ b/docs/root/source/installation/network-setup/index.rst @@ -15,5 +15,5 @@ There are several ways to setup a network. You can use the Kubernetes deployment networks network-setup k8s-deployment-template/index - bigchaindb-node-ansible.md + planetmint-node-ansible.md \ No newline at end of file diff --git a/docs/root/source/installation/network-setup/k8s-deployment-template/architecture.rst b/docs/root/source/installation/network-setup/k8s-deployment-template/architecture.rst index f057ee8..3ced18a 100644 --- a/docs/root/source/installation/network-setup/k8s-deployment-template/architecture.rst +++ b/docs/root/source/installation/network-setup/k8s-deployment-template/architecture.rst @@ -32,7 +32,7 @@ as described in these docs, it will include: `_. -.. _bigchaindb-node: +.. _planetmint-node: Planetmint Node Diagram ----------------------- @@ -104,7 +104,7 @@ Planetmint Node Diagram | +-----------+ +--------+ | | | | | +-------------+ | | | | | | | | | "Bi+directional, communication between" | - | | | | | "BigchainDBAPP) and Tendermint" | + | | | | | "PlanetmintAPP) and Tendermint" | | | | | | "BFT consensus Engine" | | | | | | | | v v | | | diff --git a/docs/root/source/installation/network-setup/k8s-deployment-template/bigchaindb-network-on-kubernetes.rst b/docs/root/source/installation/network-setup/k8s-deployment-template/bigchaindb-network-on-kubernetes.rst index 7f4f411..3e80a92 100644 --- a/docs/root/source/installation/network-setup/k8s-deployment-template/bigchaindb-network-on-kubernetes.rst +++ b/docs/root/source/installation/network-setup/k8s-deployment-template/bigchaindb-network-on-kubernetes.rst @@ -4,7 +4,7 @@ SPDX-License-Identifier: (Apache-2.0 AND CC-BY-4.0) Code is Apache-2.0 and docs are CC-BY-4.0 -.. _kubernetes-template-deploy-bigchaindb-network: +.. _kubernetes-template-deploy-planetmint-network: Kubernetes Template: Deploying a Planetmint network =================================================== @@ -44,9 +44,9 @@ to form a network. Below, we refer to multiple files by their directory and filename, -such as ``bigchaindb/bigchaindb-ext-conn-svc.yaml``. Those files are located in the -`bigchaindb/bigchaindb repository on GitHub -`_ in the ``k8s/`` directory. +such as ``planetmint/planetmint-ext-conn-svc.yaml``. Those files are located in the +`planetmint/planetmint repository on GitHub +`_ in the ``k8s/`` directory. Make sure you're getting those files from the appropriate Git branch on GitHub, i.e. the branch for the version of Planetmint that your Planetmint cluster is using. @@ -62,7 +62,7 @@ cluster is using. Once a Planetmint network is started with a certain number of validators and a genesis file. Users cannot add new validator nodes dynamically. You can track the progress of this funtionality on our - `github repository `_. + `github repository `_. .. _pre-reqs-bdb-network: @@ -229,7 +229,7 @@ the :doc:`deployment steps for each node ` N number of times the number of participants in the network. In our Kubernetes deployment template for a single Planetmint node, we covered the basic configurations -settings :ref:`here `. +settings :ref:`here `. Since, we index the ConfigMap and Secret Keys for the single site deployment, we need to update all the Kubernetes components to reflect the corresponding changes i.e. For each Kubernetes Service, @@ -267,7 +267,7 @@ the ``mongo-node-1-ss.yaml`` and update the corresponding ConfigMapKeyRef.name o terminationGracePeriodSeconds: 10 containers: - name: mongodb - image: bigchaindb/mongodb:3.2 + image: planetmint/mongodb:3.2 imagePullPolicy: IfNotPresent env: - name: MONGODB_FQDN @@ -366,13 +366,13 @@ The above example is meant to be repeated for all the Kubernetes components of a * ``mongodb/mongodb-node-X-ss.yaml`` -* ``bigchaindb/bigchaindb-node-X-svc.yaml`` +* ``planetmint/planetmint-node-X-svc.yaml`` -* ``bigchaindb/bigchaindb-node-X-sc.yaml`` +* ``planetmint/planetmint-node-X-sc.yaml`` -* ``bigchaindb/bigchaindb-node-X-pvc.yaml`` +* ``planetmint/planetmint-node-X-pvc.yaml`` -* ``bigchaindb/bigchaindb-node-X-ss.yaml`` +* ``planetmint/planetmint-node-X-ss.yaml`` * ``nginx-openresty/nginx-openresty-node-X-svc.yaml`` @@ -408,7 +408,7 @@ described :ref:`above `: * :ref:`Start the MongoDB Kubernetes Service `. -* :ref:`Start the Planetmint Kubernetes Service `. +* :ref:`Start the Planetmint Kubernetes Service `. * :ref:`Start the OpenResty Kubernetes Service `. @@ -421,22 +421,22 @@ to talk to each other i.e. specifically the communication between the Planetmint peers. Set up networking between the clusters using `Kubernetes Services `_. -Assuming we have a Planetmint instance ``bigchaindb-instance-1`` residing in Azure data center location ``westeurope`` and we -want to connect to ``bigchaindb-instance-2``, ``bigchaindb-instance-3``, and ``bigchaindb-instance-4`` located in Azure data centers +Assuming we have a Planetmint instance ``planetmint-instance-1`` residing in Azure data center location ``westeurope`` and we +want to connect to ``planetmint-instance-2``, ``planetmint-instance-3``, and ``planetmint-instance-4`` located in Azure data centers ``eastus``, ``centralus`` and ``westus``, respectively. Unless you already have explicitly set up networking for -``bigchaindb-instance-1`` to communicate with ``bigchaindb-instance-2/3/4`` and +``planetmint-instance-1`` to communicate with ``planetmint-instance-2/3/4`` and vice versa, we will have to add a Kubernetes Service in each cluster to accomplish this goal in order to set up a Planetmint P2P network. It is similar to ensuring that there is a ``CNAME`` record in the DNS -infrastructure to resolve ``bigchaindb-instance-X`` to the host where it is actually available. +infrastructure to resolve ``planetmint-instance-X`` to the host where it is actually available. We can do this in Kubernetes using a Kubernetes Service of ``type`` ``ExternalName``. -* This configuration is located in the file ``bigchaindb/bigchaindb-ext-conn-svc.yaml``. +* This configuration is located in the file ``planetmint/planetmint-ext-conn-svc.yaml``. * Set the name of the ``metadata.name`` to the host name of the Planetmint instance you are trying to connect to. - For instance if you are configuring this service on cluster with ``bigchaindb-instance-1`` then the ``metadata.name`` will - be ``bigchaindb-instance-2`` and vice versa. + For instance if you are configuring this service on cluster with ``planetmint-instance-1`` then the ``metadata.name`` will + be ``planetmint-instance-2`` and vice versa. * Set ``spec.ports.port[0]`` to the ``tm-p2p-port`` from the ConfigMap for the other cluster. @@ -452,7 +452,7 @@ We can do this in Kubernetes using a Kubernetes Service of ``type`` If you are not the system administrator of the cluster, you have to get in touch with the system administrator/s of the other ``n-1`` clusters and - share with them your instance name (``bigchaindb-instance-name`` in the ConfigMap) + share with them your instance name (``planetmint-instance-name`` in the ConfigMap) and the FQDN of the NGINX instance acting as Gateway(set in: :ref:`Assign DNS name to NGINX Public IP `). diff --git a/docs/root/source/installation/network-setup/k8s-deployment-template/index.rst b/docs/root/source/installation/network-setup/k8s-deployment-template/index.rst index 418732f..88d9732 100644 --- a/docs/root/source/installation/network-setup/k8s-deployment-template/index.rst +++ b/docs/root/source/installation/network-setup/k8s-deployment-template/index.rst @@ -42,7 +42,7 @@ Feel free change things to suit your needs or preferences. cloud-manager easy-rsa upgrade-on-kubernetes - bigchaindb-network-on-kubernetes + planetmint-network-on-kubernetes tectonic-azure troubleshoot architecture diff --git a/docs/root/source/installation/network-setup/k8s-deployment-template/log-analytics.rst b/docs/root/source/installation/network-setup/k8s-deployment-template/log-analytics.rst index b71dae5..b9e9a00 100644 --- a/docs/root/source/installation/network-setup/k8s-deployment-template/log-analytics.rst +++ b/docs/root/source/installation/network-setup/k8s-deployment-template/log-analytics.rst @@ -256,9 +256,9 @@ All logging messages containing the string "critical" but not "CriticalAddonsOnl ``Type=ContainerLog critical NOT(CriticalAddonsOnly)`` -All logging messages from containers running the Docker image bigchaindb/nginx_3scale:1.3, containing the string "GET" but not the strings "Go-http-client" or "runscope" (where those exclusions filter out tests by Kubernetes and Runscope): +All logging messages from containers running the Docker image planetmint/nginx_3scale:1.3, containing the string "GET" but not the strings "Go-http-client" or "runscope" (where those exclusions filter out tests by Kubernetes and Runscope): -``Type=ContainerLog Image="bigchaindb/nginx_3scale:1.3" GET NOT("Go-http-client") NOT(runscope)`` +``Type=ContainerLog Image="planetmint/nginx_3scale:1.3" GET NOT("Go-http-client") NOT(runscope)`` .. note:: diff --git a/docs/root/source/installation/network-setup/k8s-deployment-template/node-config-map-and-secrets.rst b/docs/root/source/installation/network-setup/k8s-deployment-template/node-config-map-and-secrets.rst index 0b09e23..c2d3c19 100644 --- a/docs/root/source/installation/network-setup/k8s-deployment-template/node-config-map-and-secrets.rst +++ b/docs/root/source/installation/network-setup/k8s-deployment-template/node-config-map-and-secrets.rst @@ -4,7 +4,7 @@ SPDX-License-Identifier: (Apache-2.0 AND CC-BY-4.0) Code is Apache-2.0 and docs are CC-BY-4.0 -.. _how-to-configure-a-bigchaindb-node: +.. _how-to-configure-a-planetmint-node: How to Configure a Planetmint Node ================================== diff --git a/docs/root/source/installation/network-setup/k8s-deployment-template/node-on-kubernetes.rst b/docs/root/source/installation/network-setup/k8s-deployment-template/node-on-kubernetes.rst index 15d7ca3..7a40bf5 100644 --- a/docs/root/source/installation/network-setup/k8s-deployment-template/node-on-kubernetes.rst +++ b/docs/root/source/installation/network-setup/k8s-deployment-template/node-on-kubernetes.rst @@ -4,7 +4,7 @@ SPDX-License-Identifier: (Apache-2.0 AND CC-BY-4.0) Code is Apache-2.0 and docs are CC-BY-4.0 -.. _kubernetes-template-deploy-a-single-bigchaindb-node: +.. _kubernetes-template-deploy-a-single-planetmint-node: Kubernetes Template: Deploy a Single Planetmint Node ==================================================== @@ -26,7 +26,7 @@ It assumes you already have a running Kubernetes cluster. Below, we refer to many files by their directory and filename, such as ``configuration/config-map.yaml``. Those files are files in the -`bigchaindb/bigchaindb repository on GitHub `_ +`planetmint/planetmint repository on GitHub `_ in the ``k8s/`` directory. Make sure you're getting those files from the appropriate Git branch on GitHub, i.e. the branch for the version of Planetmint that your Planetmint @@ -132,7 +132,7 @@ That means you can visit the dashboard in your web browser at Step 3: Configure Your Planetmint Node -------------------------------------- -See the page titled :ref:`how-to-configure-a-bigchaindb-node`. +See the page titled :ref:`how-to-configure-a-planetmint-node`. .. _start-the-nginx-service: @@ -166,7 +166,7 @@ Step 5: Assign DNS Name to the NGINX Public IP * This step is required only if you are planning to set up multiple `Planetmint nodes - `_ or are using + `_ or are using HTTPS certificates tied to a domain. * The following command can help you find out if the NGINX service started @@ -214,7 +214,7 @@ Step 6: Start the MongoDB Kubernetes Service $ kubectl apply -f mongodb/mongo-svc.yaml -.. _start-the-bigchaindb-kubernetes-service: +.. _start-the-planetmint-kubernetes-service: Step 7: Start the Planetmint Kubernetes Service ----------------------------------------------- @@ -223,7 +223,7 @@ Step 7: Start the Planetmint Kubernetes Service .. code:: bash - $ kubectl apply -f bigchaindb/bigchaindb-svc.yaml + $ kubectl apply -f planetmint/planetmint-svc.yaml .. _start-the-openresty-kubernetes-service: @@ -437,7 +437,7 @@ Planetmint needs somewhere to store Tendermint data persistently, Tendermint use LevelDB as the persistent storage layer. The Kubernetes template for configuration of Storage Class is located in the -file ``bigchaindb/bigchaindb-sc.yaml``. +file ``planetmint/planetmint-sc.yaml``. Details about how to create a Azure Storage account and how Kubernetes Storage Class works are already covered in this document: :ref:`create-kubernetes-storage-class-mdb`. @@ -446,7 +446,7 @@ Create the required storage classes using: .. code:: bash - $ kubectl apply -f bigchaindb/bigchaindb-sc.yaml + $ kubectl apply -f planetmint/planetmint-sc.yaml You can check if it worked using ``kubectl get storageclasses``. @@ -459,7 +459,7 @@ Step 15: Create Kubernetes Persistent Volume Claims for Planetmint Next, you will create two PersistentVolumeClaim objects ``tendermint-db-claim`` and ``tendermint-config-db-claim``. -This configuration is located in the file ``bigchaindb/bigchaindb-pvc.yaml``. +This configuration is located in the file ``planetmint/planetmint-pvc.yaml``. Details about Kubernetes Persistent Volumes, Persistent Volume Claims and how they work with Azure are already covered in this @@ -469,7 +469,7 @@ Create the required Persistent Volume Claims using: .. code:: bash - $ kubectl apply -f bigchaindb/bigchaindb-pvc.yaml + $ kubectl apply -f planetmint/planetmint-pvc.yaml You can check its status using: @@ -483,7 +483,7 @@ You can check its status using: Step 16: Start a Kubernetes StatefulSet for Planetmint ------------------------------------------------------ - * This configuration is located in the file ``bigchaindb/bigchaindb-ss.yaml``. + * This configuration is located in the file ``planetmint/planetmint-ss.yaml``. * Set the ``spec.serviceName`` to the value set in ``bdb-instance-name`` in the ConfigMap. @@ -505,7 +505,7 @@ Step 16: Start a Kubernetes StatefulSet for Planetmint .. code:: bash - $ kubectl apply -f bigchaindb/bigchaindb-ss.yaml + $ kubectl apply -f planetmint/planetmint-ss.yaml .. code:: bash @@ -570,7 +570,7 @@ Step 18(Optional): Start a Kubernetes Deployment for OpenResty - ``node-dns-server-ip`` - ``openresty-backend-port`` - ``ngx-bdb-instance-name`` - - ``bigchaindb-api-port`` + - ``planetmint-api-port`` * Create the OpenResty Deployment using: @@ -610,7 +610,7 @@ infrastructure to resolve ``bdb-instance-X`` to the host where it is actually av We can do this in Kubernetes using a Kubernetes Service of ``type`` ``ExternalName``. -* This configuration is located in the file ``bigchaindb/bigchaindb-ext-conn-svc.yaml``. +* This configuration is located in the file ``planetmint/planetmint-ext-conn-svc.yaml``. * Set the name of the ``metadata.name`` to the host name of the Planetmint instance you are trying to connect to. For instance if you are configuring this service on cluster with ``bdb-instance-1`` then the ``metadata.name`` will @@ -646,17 +646,17 @@ Step 21.1: Testing Internally To test the setup of your Planetmint node, you could use a Docker container that provides utilities like ``nslookup``, ``curl`` and ``dig``. For example, you could use a container based on our -`bigchaindb/toolbox `_ image. +`planetmint/toolbox `_ image. (The corresponding -`Dockerfile `_ -is in the ``bigchaindb/bigchaindb`` repository on GitHub.) +`Dockerfile `_ +is in the ``planetmint/planetmint`` repository on GitHub.) You can use it as below to get started immediately: .. code:: bash $ kubectl \ run -it toolbox \ - --image bigchaindb/toolbox \ + --image planetmint/toolbox \ --image-pull-policy=Always \ --restart=Never --rm diff --git a/docs/root/source/installation/network-setup/k8s-deployment-template/troubleshoot.rst b/docs/root/source/installation/network-setup/k8s-deployment-template/troubleshoot.rst index 22a7563..93d838e 100644 --- a/docs/root/source/installation/network-setup/k8s-deployment-template/troubleshoot.rst +++ b/docs/root/source/installation/network-setup/k8s-deployment-template/troubleshoot.rst @@ -31,7 +31,7 @@ container and looking at the syslog (the ``journalctl`` command should usually work). This issue is resolved in -`PR #1757 `_. +`PR #1757 `_. 2. 502 Bad Gateway Error on Runscope Tests ------------------------------------------ diff --git a/docs/root/source/installation/network-setup/k8s-deployment-template/workflow.rst b/docs/root/source/installation/network-setup/k8s-deployment-template/workflow.rst index 5c682af..4f00dae 100644 --- a/docs/root/source/installation/network-setup/k8s-deployment-template/workflow.rst +++ b/docs/root/source/installation/network-setup/k8s-deployment-template/workflow.rst @@ -145,7 +145,7 @@ then you will run a script which reads that file to generate some Kubernetes con you will send those config files to your Kubernetes cluster, and then you will deploy all the stuff that you need to have a Planetmint node. -⟶ Proceed to :ref:`deploy your Planetmint node `. +⟶ Proceed to :ref:`deploy your Planetmint node `. .. raw:: html diff --git a/docs/root/source/installation/network-setup/network-setup.md b/docs/root/source/installation/network-setup/network-setup.md index 74bdf37..8c666b4 100644 --- a/docs/root/source/installation/network-setup/network-setup.md +++ b/docs/root/source/installation/network-setup/network-setup.md @@ -173,10 +173,10 @@ Install Monit: sudo apt install monit ``` -If you installed the `bigchaindb` Python package as above, you should have the `bigchaindb-monit-config` script in your `PATH` now. Run the script to build a configuration file for Monit: +If you installed the `planetmint` Python package as above, you should have the `planetmint-monit-config` script in your `PATH` now. Run the script to build a configuration file for Monit: ``` -bigchaindb-monit-config +planetmint-monit-config ``` Run Monit as a daemon, instructing it to wake up every second to check on processes: @@ -185,23 +185,23 @@ Run Monit as a daemon, instructing it to wake up every second to check on proces monit -d 1 ``` -Monit will run the Planetmint and Tendermint processes and restart them when they crash. If the root `bigchaindb_` process crashes, Monit will also restart the Tendermint process. +Monit will run the Planetmint and Tendermint processes and restart them when they crash. If the root `planetmint_` process crashes, Monit will also restart the Tendermint process. You can check the status by running `monit status` or `monit summary`. -By default, it will collect program logs into the `~/.bigchaindb-monit/logs` folder. +By default, it will collect program logs into the `~/.planetmint-monit/logs` folder. To learn more about Monit, use `monit -h` (help) or read [the Monit documentation][monit-manual]. -Check `bigchaindb-monit-config -h` if you want to arrange a different folder for logs or some of the Monit internal artifacts. +Check `planetmint-monit-config -h` if you want to arrange a different folder for logs or some of the Monit internal artifacts. -If you want to start and manage the Planetmint and Tendermint processes yourself, then look inside the file [bigchaindb/pkg/scripts/bigchaindb-monit-config](https://github.com/bigchaindb/bigchaindb/blob/master/pkg/scripts/bigchaindb-monit-config) to see how *it* starts Planetmint and Tendermint. +If you want to start and manage the Planetmint and Tendermint processes yourself, then look inside the file [planetmint/pkg/scripts/planetmint-monit-config](https://github.com/planetmint/planetmint/blob/master/pkg/scripts/planetmint-monit-config) to see how *it* starts Planetmint and Tendermint. ## How Others Can Access Your Node If you followed the above instructions, then your node should be publicly-accessible with Planetmint Root URL `https://hostname` or `http://hostname:9984`. That is, anyone can interact with your node using the [Planetmint HTTP API](../api/http-client-server-api) exposed at that address. The most common way to do that is to use one of the [Planetmint Drivers](../../drivers/index). -[bdb:software]: https://github.com/bigchaindb/bigchaindb/ +[bdb:software]: https://github.com/planetmint/planetmint/ [bdb:pypi]: https://pypi.org/project/Planetmint/#history [tendermint:releases]: https://github.com/tendermint/tendermint/releases [monit]: https://www.mmonit.com/monit diff --git a/docs/root/source/installation/network-setup/networks.md b/docs/root/source/installation/network-setup/networks.md index 9943c04..fbe3d8a 100644 --- a/docs/root/source/installation/network-setup/networks.md +++ b/docs/root/source/installation/network-setup/networks.md @@ -7,7 +7,7 @@ Code is Apache-2.0 and docs are CC-BY-4.0 # Planetmint Networks -A **Planetmint network** is a set of connected **Planetmint nodes**, managed by a **Planetmint consortium** (i.e. an organization). Those terms are defined in the [Planetmint Terminology page](https://docs.bigchaindb.com/en/latest/terminology.html). +A **Planetmint network** is a set of connected **Planetmint nodes**, managed by a **Planetmint consortium** (i.e. an organization). Those terms are defined in the [Planetmint Terminology page](https://docs.planetmint.io/en/latest/terminology.html). ## Consortium Structure & Governance @@ -17,7 +17,7 @@ A governance process is required to make those decisions, and therefore one of t This documentation doesn't explain how to create a consortium, nor does it outline the possible governance processes. It's worth noting that the decentralization of a Planetmint network depends, -to some extent, on the decentralization of the associated consortium. See the pages about [decentralization](https://docs.bigchaindb.com/en/latest/decentralized.html) and [node diversity](https://docs.bigchaindb.com/en/latest/diversity.html). +to some extent, on the decentralization of the associated consortium. See the pages about [decentralization](https://docs.planetmint.io/en/latest/decentralized.html) and [node diversity](https://docs.planetmint.io/en/latest/diversity.html). ## DNS Records and SSL Certificates diff --git a/docs/root/source/installation/node-setup/all-in-one-bigchaindb.md b/docs/root/source/installation/node-setup/all-in-one-bigchaindb.md index d3806a4..19af49f 100644 --- a/docs/root/source/installation/node-setup/all-in-one-bigchaindb.md +++ b/docs/root/source/installation/node-setup/all-in-one-bigchaindb.md @@ -10,7 +10,7 @@ Code is Apache-2.0 and docs are CC-BY-4.0 For those who like using Docker and wish to experiment with Planetmint in non-production environments, we currently maintain a Planetmint all-in-one Docker image and a -`Dockerfile-all-in-one` that can be used to build an image for `bigchaindb`. +`Dockerfile-all-in-one` that can be used to build an image for `planetmint`. This image contains all the services required for a Planetmint node i.e. @@ -21,8 +21,8 @@ This image contains all the services required for a Planetmint node i.e. **Note:** **NOT for Production Use:** *This is an single node opinionated image not well suited for a network deployment.* *This image is to help quick deployment for early adopters, for a more standard approach please refer to one of our deployment guides:* -- [Planetmint developer setup guides](https://docs.bigchaindb.com/projects/contributing/en/latest/dev-setup-coding-and-contribution-process/index.html). -- [Planetmint with Kubernetes](http://docs.bigchaindb.com/projects/server/en/latest/k8s-deployment-template/index.html). +- [Planetmint developer setup guides](https://docs.planetmint.io/projects/contributing/en/latest/dev-setup-coding-and-contribution-process/index.html). +- [Planetmint with Kubernetes](http://docs.planetmint.io/projects/server/en/latest/k8s-deployment-template/index.html). ## Prerequisite(s) - [Docker](https://docs.docker.com/engine/installation/) @@ -33,19 +33,19 @@ With Docker installed, you can proceed as follows. In a terminal shell, pull the latest version of the Planetmint all-in-one Docker image using: ```text -$ docker pull bigchaindb/bigchaindb:all-in-one +$ docker pull planetmint/planetmint:all-in-one $ docker run \ --detach \ - --name bigchaindb \ + --name planetmint \ --publish 9984:9984 \ --publish 9985:9985 \ --publish 27017:27017 \ --publish 26657:26657 \ - --volume $HOME/bigchaindb_docker/mongodb/data/db:/data/db \ - --volume $HOME/bigchaindb_docker/mongodb/data/configdb:/data/configdb \ - --volume $HOME/bigchaindb_docker/tendermint:/tendermint \ - bigchaindb/bigchaindb:all-in-one + --volume $HOME/planetmint_docker/mongodb/data/db:/data/db \ + --volume $HOME/planetmint_docker/mongodb/data/configdb:/data/configdb \ + --volume $HOME/planetmint_docker/tendermint:/tendermint \ + planetmint/planetmint:all-in-one ``` Let's analyze that command: @@ -57,18 +57,18 @@ Let's analyze that command: * `9985` Planetmint Websocket server * `27017` Default port for MongoDB * `26657` Tendermint RPC server -* `--volume "$HOME/bigchaindb_docker/mongodb:/data"` map the host directory - `$HOME/bigchaindb_docker/mongodb` to the container directory `/data`; +* `--volume "$HOME/planetmint_docker/mongodb:/data"` map the host directory + `$HOME/planetmint_docker/mongodb` to the container directory `/data`; this allows us to have the data persisted on the host machine, you can read more in the [official Docker documentation](https://docs.docker.com/engine/tutorials/dockervolumes) - * `$HOME/bigchaindb_docker/tendermint:/tendermint` to persist Tendermint data. -* `bigchaindb/bigchaindb:all-in-one` the image to use. All the options after the container name are passed on to the entrypoint inside the container. + * `$HOME/planetmint_docker/tendermint:/tendermint` to persist Tendermint data. +* `planetmint/planetmint:all-in-one` the image to use. All the options after the container name are passed on to the entrypoint inside the container. ## Verify ```text -$ docker ps | grep bigchaindb +$ docker ps | grep planetmint ``` Send your first transaction using [Planetmint drivers](../../drivers/index). @@ -80,8 +80,8 @@ Assuming you have Docker installed, you would proceed as follows. In a terminal shell: ```text -git clone git@github.com:bigchaindb/bigchaindb.git -cd bigchaindb/ +git clone git@github.com:planetmint/planetmint.git +cd planetmint/ ``` Build the Docker image: diff --git a/docs/root/source/installation/node-setup/bigchaindb-cli.md b/docs/root/source/installation/node-setup/bigchaindb-cli.md index 44865f8..ab0c4b3 100644 --- a/docs/root/source/installation/node-setup/bigchaindb-cli.md +++ b/docs/root/source/installation/node-setup/bigchaindb-cli.md @@ -7,20 +7,20 @@ Code is Apache-2.0 and docs are CC-BY-4.0 # Command Line Interface (CLI) -The command-line command to interact with Planetmint Server is `bigchaindb`. +The command-line command to interact with Planetmint Server is `planetmint`. -## bigchaindb \-\-help +## planetmint \-\-help -Show help for the `bigchaindb` command. `bigchaindb -h` does the same thing. +Show help for the `planetmint` command. `planetmint -h` does the same thing. -## bigchaindb \-\-version +## planetmint \-\-version -Show the version number. `bigchaindb -v` does the same thing. +Show the version number. `planetmint -v` does the same thing. -## bigchaindb configure +## planetmint configure Generate a local configuration file (which can be used to set some or all [Planetmint node configuration settings](configuration)). It will ask you for the values of some configuration settings. If you press Enter for a value, it will use the default value. @@ -29,39 +29,39 @@ At this point, only one database backend is supported: `localmongodb`. If you use the `-c` command-line option, it will generate the file at the specified path: ```text -bigchaindb -c path/to/new_config.json configure localmongodb +planetmint -c path/to/new_config.json configure localmongodb ``` -If you don't use the `-c` command-line option, the file will be written to `$HOME/.bigchaindb` (the default location where Planetmint looks for a config file, if one isn't specified). +If you don't use the `-c` command-line option, the file will be written to `$HOME/.planetmint` (the default location where Planetmint looks for a config file, if one isn't specified). If you use the `-y` command-line option, then there won't be any interactive prompts: it will use the default values for all the configuration settings. ```text -bigchaindb -y configure localmongodb +planetmint -y configure localmongodb ``` -## bigchaindb show-config +## planetmint show-config Show the values of the [Planetmint node configuration settings](configuration). -## bigchaindb init +## planetmint init Create a backend database (local MongoDB), all database tables/collections, various backend database indexes, and the genesis block. -## bigchaindb drop +## planetmint drop Drop (erase) the backend database (the local MongoDB database used by this node). You will be prompted to make sure. -If you want to force-drop the database (i.e. skipping the yes/no prompt), then use `bigchaindb -y drop` +If you want to force-drop the database (i.e. skipping the yes/no prompt), then use `planetmint -y drop` -## bigchaindb start +## planetmint start -Start Planetmint. It always begins by trying a `bigchaindb init` first. See the documentation for `bigchaindb init`. -The database initialization step is optional and can be skipped by passing the `--no-init` flag, i.e. `bigchaindb start --no-init`. +Start Planetmint. It always begins by trying a `planetmint init` first. See the documentation for `planetmint init`. +The database initialization step is optional and can be skipped by passing the `--no-init` flag, i.e. `planetmint start --no-init`. ### Options @@ -69,7 +69,7 @@ The log level for the console can be set via the option `--log-level` or its abbreviation `-l`. Example: ```bash -$ bigchaindb --log-level INFO start +$ planetmint --log-level INFO start ``` The allowed levels are `DEBUG`, `INFO`, `WARNING`, `ERROR`, and `CRITICAL`. @@ -82,9 +82,9 @@ configuration file as documented under [Configuration Settings](configuration). -## bigchaindb election +## planetmint election -Manage elections to govern the Planetmint network. The specifics of the election process are defined in [BEP-18](https://github.com/bigchaindb/BEPs/tree/master/18). +Manage elections to govern the Planetmint network. The specifics of the election process are defined in [BEP-18](https://github.com/planetmint/BEPs/tree/master/18). Election management is broken into several subcommands. Below is the command line syntax for each of them. @@ -106,7 +106,7 @@ Create an election to add, update, or remove a validator. ```bash -$ bigchaindb election new upsert-validator --private-key +$ planetmint election new upsert-validator --private-key ``` - `` is the public key of the node to be added/updated/removed. The encoding and type of the key have to match those specified in `genesis.json` in the supported Tendermint version. @@ -117,7 +117,7 @@ $ bigchaindb election new upsert-validator --priv Example: ```bash -$ bigchaindb election new upsert-validator HHG0IQRybpT6nJMIWWFWhMczCLHt6xcm7eP52GnGuPY= 1 fb7140f03a4ffad899fabbbf655b97e0321add66 --private-key /home/user/.tendermint/config/priv_validator.json +$ planetmint election new upsert-validator HHG0IQRybpT6nJMIWWFWhMczCLHt6xcm7eP52GnGuPY= 1 fb7140f03a4ffad899fabbbf655b97e0321add66 --private-key /home/user/.tendermint/config/priv_validator.json [SUCCESS] Submitted proposal with id: 04a067582cf03eba2b53b82e4adb5ece424474cbd4f7183780855a93ac5e3caa ``` @@ -126,7 +126,7 @@ Once `election_id` has been generated, the proposer should share it with other v Note that election proposers do not automatically approve elections by proposing them. -For more details about how validator set changes work, refer to [BEP-21](https://github.com/bigchaindb/BEPs/tree/master/21). +For more details about how validator set changes work, refer to [BEP-21](https://github.com/planetmint/BEPs/tree/master/21). #### election new chain-migration @@ -134,7 +134,7 @@ Create an election to halt block production, to coordinate on making a Tendermin ```bash -$ bigchaindb election new chain-migration --private-key +$ planetmint election new chain-migration --private-key ``` - `` is the path to the private key of the validator who proposes the election. Tendermint places it at `.tendermint/config/priv_validator.json`. @@ -143,7 +143,7 @@ $ bigchaindb election new chain-migration --private-key --private-key +$ planetmint election approve --private-key ``` - `election-id` is the election identifier the approval is given for. @@ -167,7 +167,7 @@ $ bigchaindb election approve --private-key +$ planetmint election show status= ``` @@ -192,11 +192,11 @@ status= After a chain migration is concluded, the `show` command also outputs `chain_id`, `app_hash`, and `validators` for `genesis.json` of the new chain. -## bigchaindb tendermint-version +## planetmint tendermint-version Show the Tendermint versions supported by Planetmint server. ```bash -$ bigchaindb tendermint-version +$ planetmint tendermint-version { "description": "Planetmint supports the following Tendermint version(s)", "tendermint": [ diff --git a/docs/root/source/installation/node-setup/bigchaindb-node-ansible.md b/docs/root/source/installation/node-setup/bigchaindb-node-ansible.md index 53733d9..4d36470 100644 --- a/docs/root/source/installation/node-setup/bigchaindb-node-ansible.md +++ b/docs/root/source/installation/node-setup/bigchaindb-node-ansible.md @@ -2,6 +2,6 @@ You can find one of the installation methods with Ansible on GitHub at: -[Ansible script](https://github.com/bigchaindb/bigchaindb-node-ansible) +[Ansible script](https://github.com/planetmint/planetmint-node-ansible) It allows to install Planetmint, MongoDB, Tendermint, and python, and then connect nodes into a network. Current tested machine is Ubuntu 18.04. \ No newline at end of file diff --git a/docs/root/source/installation/node-setup/configuration.md b/docs/root/source/installation/node-setup/configuration.md index 330d359..62123d7 100644 --- a/docs/root/source/installation/node-setup/configuration.md +++ b/docs/root/source/installation/node-setup/configuration.md @@ -21,13 +21,13 @@ The value of each setting is determined according to the following rules: * Otherwise, if it's set in a local config file, then use that value * Otherwise, use the default value -The local config file is `$HOME/.bigchaindb` by default (a file which might not even exist), but you can tell Planetmint to use a different file by using the `-c` command-line option, e.g. `bigchaindb -c path/to/config_file.json start` -or using the `PLANETMINT_CONFIG_PATH` environment variable, e.g. `BIGHAINDB_CONFIG_PATH=.my_bigchaindb_config bigchaindb start`. +The local config file is `$HOME/.planetmint` by default (a file which might not even exist), but you can tell Planetmint to use a different file by using the `-c` command-line option, e.g. `planetmint -c path/to/config_file.json start` +or using the `PLANETMINT_CONFIG_PATH` environment variable, e.g. `BIGHAINDB_CONFIG_PATH=.my_planetmint_config planetmint start`. Note that the `-c` command line option will always take precedence if both the `PLANETMINT_CONFIG_PATH` and the `-c` command line option are used. -You can read the current default values in the file [bigchaindb/\_\_init\_\_.py](https://github.com/bigchaindb/bigchaindb/blob/master/bigchaindb/__init__.py). (The link is to the latest version.) +You can read the current default values in the file [planetmint/\_\_init\_\_.py](https://github.com/planetmint/planetmint/blob/master/planetmint/__init__.py). (The link is to the latest version.) -Running `bigchaindb -y configure localmongodb` will generate a local config file in `$HOME/.bigchaindb` with all the default values. +Running `planetmint -y configure localmongodb` will generate a local config file in `$HOME/.planetmint` with all the default values. ## database.* @@ -37,7 +37,7 @@ The settings with names of the form `database.*` are for the backend database * `database.backend` can only be `localmongodb`, currently. * `database.host` is the hostname (FQDN) of the backend database. * `database.port` is self-explanatory. -* `database.name` is a user-chosen name for the database inside MongoDB, e.g. `bigchain`. +* `database.name` is a user-chosen name for the database inside MongoDB, e.g. `planetmint`. * `database.connection_timeout` is the maximum number of milliseconds that Planetmint will wait before giving up on one attempt to connect to the backend database. * `database.max_tries` is the maximum number of times that Planetmint will try to establish a connection with the backend database. If 0, then it will try forever. * `database.replicaset` is the name of the MongoDB replica set. The default value is `null` because in Planetmint 2.0+, each Planetmint node has its own independent MongoDB database and no replica set is necessary. Replica set must already exist if this option is configured, Planetmint will not create it. @@ -51,7 +51,7 @@ If you use all the default Planetmint configuration settings, then no authentica **Username/Password Authentication** -To use username/password authentication, a MongoDB instance must already be running somewhere (maybe in another machine), it must already have a database for use by Planetmint (usually named `bigchain`, which is the default `database.name`), and that database must already have a "readWrite" user with associated username and password. To create such a user, login to your MongoDB instance as Admin and run the following commands: +To use username/password authentication, a MongoDB instance must already be running somewhere (maybe in another machine), it must already have a database for use by Planetmint (usually named `planetmint`, which is the default `database.name`), and that database must already have a "readWrite" user with associated username and password. To create such a user, login to your MongoDB instance as Admin and run the following commands: ```text use @@ -64,7 +64,7 @@ db.createUser({user: "", pwd: "", roles: [{ro **x.509 Certificate Authentication** -To use x.509 certificate authentication, a MongoDB instance must be running somewhere (maybe in another machine), it must already have a database for use by Planetmint (usually named `bigchain`, which is the default `database.name`), and that database must be set up to use x.509 authentication. See the MongoDB docs about how to do that. +To use x.509 certificate authentication, a MongoDB instance must be running somewhere (maybe in another machine), it must already have a database for use by Planetmint (usually named `planetmint`, which is the default `database.name`), and that database must be set up to use x.509 authentication. See the MongoDB docs about how to do that. * `database.login` is the user's username. * `database.password` isn't used so the default value (`null`) is fine. @@ -84,14 +84,14 @@ export PLANETMINT_DATABASE_MAX_TRIES=3 **Default values** -If (no environment variables were set and there's no local config file), or you used `bigchaindb -y configure localmongodb` to create a default local config file for a `localmongodb` backend, then the defaults will be: +If (no environment variables were set and there's no local config file), or you used `planetmint -y configure localmongodb` to create a default local config file for a `localmongodb` backend, then the defaults will be: ```js "database": { "backend": "localmongodb", "host": "localhost", "port": 27017, - "name": "bigchain", + "name": "planetmint", "connection_timeout": 5000, "max_tries": 3, "replicaset": null, @@ -213,7 +213,7 @@ different from where Planetmint is running. ```text export PLANETMINT_WSSERVER_ADVERTISED_SCHEME=wss -export PLANETMINT_WSSERVER_ADVERTISED_HOST=mybigchaindb.com +export PLANETMINT_WSSERVER_ADVERTISED_HOST=myplanetmint.io export PLANETMINT_WSSERVER_ADVERTISED_PORT=443 ``` @@ -222,7 +222,7 @@ export PLANETMINT_WSSERVER_ADVERTISED_PORT=443 ```js "wsserver": { "advertised_scheme": "wss", - "advertised_host": "mybigchaindb.com", + "advertised_host": "myplanetmint.io", "advertised_port": 443 } ``` @@ -246,8 +246,8 @@ The `log.*` settings are to configure logging. ```js { "log": { - "file": "/var/log/bigchaindb.log", - "error_file": "/var/log/bigchaindb-errors.log", + "file": "/var/log/planetmint.log", + "error_file": "/var/log/planetmint-errors.log", "level_console": "info", "level_logfile": "info", "datefmt_console": "%Y-%m-%d %H:%M:%S", @@ -263,8 +263,8 @@ The `log.*` settings are to configure logging. ```js { "log": { - "file": "~/bigchaindb.log", - "error_file": "~/bigchaindb-errors.log", + "file": "~/planetmint.log", + "error_file": "~/planetmint-errors.log", "level_console": "info", "level_logfile": "info", "datefmt_console": "%Y-%m-%d %H:%M:%S", @@ -278,19 +278,19 @@ The `log.*` settings are to configure logging. ### log.file The full path to the file where logs should be written. -The user running `bigchaindb` must have write access to the +The user running `planetmint` must have write access to the specified path. **Log rotation:** Log files have a size limit of about 200 MB and will be rotated up to five times. -For example, if `log.file` is set to `"~/bigchain.log"`, then -logs would always be written to `bigchain.log`. Each time the file -`bigchain.log` reaches 200 MB it will be closed and renamed -`bigchain.log.1`. If `bigchain.log.1` and `bigchain.log.2` already exist they -would be renamed `bigchain.log.2` and `bigchain.log.3`. This pattern would be -applied up to `bigchain.log.5` after which `bigchain.log.5` would be -overwritten by `bigchain.log.4`, thus ending the rotation cycle of whatever -logs were in `bigchain.log.5`. +For example, if `log.file` is set to `"~/planetmint.log"`, then +logs would always be written to `planetmint.log`. Each time the file +`planetmint.log` reaches 200 MB it will be closed and renamed +`planetmint.log.1`. If `planetmint.log.1` and `planetmint.log.2` already exist they +would be renamed `planetmint.log.2` and `planetmint.log.3`. This pattern would be +applied up to `planetmint.log.5` after which `planetmint.log.5` would be +overwritten by `planetmint.log.4`, thus ending the rotation cycle of whatever +logs were in `planetmint.log.5`. ### log.error_file diff --git a/docs/root/source/installation/node-setup/index.rst b/docs/root/source/installation/node-setup/index.rst index 08a3827..e7efc00 100644 --- a/docs/root/source/installation/node-setup/index.rst +++ b/docs/root/source/installation/node-setup/index.rst @@ -14,12 +14,12 @@ You can use the all-in-one docker solution, or install Tendermint, MongoDB, and deploy-a-machine aws-setup - all-in-one-bigchaindb - bigchaindb-node-ansible + all-in-one-planetmint + planetmint-node-ansible set-up-node-software set-up-nginx configuration - bigchaindb-cli + planetmint-cli troubleshooting production-node/index release-notes diff --git a/docs/root/source/installation/node-setup/production-node/node-assumptions.md b/docs/root/source/installation/node-setup/production-node/node-assumptions.md index cc1aa8e..92b566d 100644 --- a/docs/root/source/installation/node-setup/production-node/node-assumptions.md +++ b/docs/root/source/installation/node-setup/production-node/node-assumptions.md @@ -9,7 +9,7 @@ Code is Apache-2.0 and docs are CC-BY-4.0 Be sure you know the key Planetmint terminology: -* [Planetmint node, Planetmint network and Planetmint consortium](https://docs.bigchaindb.com/en/latest/terminology.html) +* [Planetmint node, Planetmint network and Planetmint consortium](https://docs.planetmint.io/en/latest/terminology.html) Note that there are a few kinds of nodes: diff --git a/docs/root/source/installation/node-setup/production-node/node-requirements.md b/docs/root/source/installation/node-setup/production-node/node-requirements.md index c54d11f..4697cf0 100644 --- a/docs/root/source/installation/node-setup/production-node/node-requirements.md +++ b/docs/root/source/installation/node-setup/production-node/node-requirements.md @@ -13,7 +13,7 @@ Code is Apache-2.0 and docs are CC-BY-4.0 Planetmint Server requires Python 3.5+ and Python 3.5+ [will run on any modern OS](https://docs.python.org/3.5/using/index.html), but we recommend using an LTS version of [Ubuntu Server](https://www.ubuntu.com/server) or a similarly server-grade Linux distribution. -_Don't use macOS_ (formerly OS X, formerly Mac OS X), because it's not a server-grade operating system. Also, BigchaindB Server uses the Python multiprocessing package and [some functionality in the multiprocessing package doesn't work on Mac OS X](https://docs.python.org/3.6/library/multiprocessing.html#multiprocessing.Queue.qsize). +_Don't use macOS_ (formerly OS X, formerly Mac OS X), because it's not a server-grade operating system. Also, Planetmint Server uses the Python multiprocessing package and [some functionality in the multiprocessing package doesn't work on Mac OS X](https://docs.python.org/3.6/library/multiprocessing.html#multiprocessing.Queue.qsize). ## General Considerations diff --git a/docs/root/source/installation/node-setup/production-node/reverse-proxy-notes.md b/docs/root/source/installation/node-setup/production-node/reverse-proxy-notes.md index 27e4ffe..732742c 100644 --- a/docs/root/source/installation/node-setup/production-node/reverse-proxy-notes.md +++ b/docs/root/source/installation/node-setup/production-node/reverse-proxy-notes.md @@ -28,7 +28,7 @@ Below, we note how a reverse proxy can be used to do some Planetmint-specific things. You may also be interested in -[our NGINX configuration file template](https://github.com/bigchaindb/nginx_3scale/blob/master/nginx.conf.template) +[our NGINX configuration file template](https://github.com/planetmint/nginx_3scale/blob/master/nginx.conf.template) (open source, on GitHub). @@ -55,4 +55,4 @@ For more information, see [the NGINX docs about client_max_body_size](https://nginx.org/en/docs/http/ngx_http_core_module.html#client_max_body_size). Note: By enforcing a maximum transaction size, you -[indirectly enforce a maximum crypto-conditions complexity](https://github.com/bigchaindb/bigchaindb/issues/356#issuecomment-288085251). +[indirectly enforce a maximum crypto-conditions complexity](https://github.com/planetmint/planetmint/issues/356#issuecomment-288085251). diff --git a/docs/root/source/installation/node-setup/release-notes.md b/docs/root/source/installation/node-setup/release-notes.md index 609885e..4dfbe1c 100644 --- a/docs/root/source/installation/node-setup/release-notes.md +++ b/docs/root/source/installation/node-setup/release-notes.md @@ -9,8 +9,8 @@ Code is Apache-2.0 and docs are CC-BY-4.0 You can find a list of all Planetmint Server releases and release notes on GitHub at: -[https://github.com/bigchaindb/bigchaindb/releases](https://github.com/bigchaindb/bigchaindb/releases) +[https://github.com/planetmint/planetmint/releases](https://github.com/planetmint/planetmint/releases) -The [CHANGELOG.md file](https://github.com/bigchaindb/bigchaindb/blob/master/CHANGELOG.md) contains much the same information, but it also has notes about what to expect in the _next_ release. +The [CHANGELOG.md file](https://github.com/planetmint/planetmint/blob/master/CHANGELOG.md) contains much the same information, but it also has notes about what to expect in the _next_ release. -We also have [a roadmap document in ROADMAP.md](https://github.com/bigchaindb/org/blob/master/ROADMAP.md). +We also have [a roadmap document in ROADMAP.md](https://github.com/planetmint/org/blob/master/ROADMAP.md). diff --git a/docs/root/source/installation/node-setup/set-up-nginx.md b/docs/root/source/installation/node-setup/set-up-nginx.md index 689c0b7..aa4f486 100644 --- a/docs/root/source/installation/node-setup/set-up-nginx.md +++ b/docs/root/source/installation/node-setup/set-up-nginx.md @@ -31,7 +31,7 @@ Get an SSL certificate for your node's subdomain (such as `bnode.example.com`). * Create a "PEM file" (text file) by concatenating your SSL certificate with all intermediate certificates (_in that order, with the intermediate certs last_). * Copy that PEM file into `/etc/nginx/ssl/cert.pem` * In the - [bigchaindb/bigchaindb repository on GitHub](https://github.com/bigchaindb/bigchaindb), + [planetmint/planetmint repository on GitHub](https://github.com/planetmint/planetmint), find the file `nginx/nginx.conf` and copy its contents to `/etc/nginx/nginx.conf` on your machine (i.e. replace the existing file there). * Edit that file (`/etc/nginx/nginx.conf`): replace the two instances of diff --git a/docs/root/source/installation/node-setup/set-up-node-software.md b/docs/root/source/installation/node-setup/set-up-node-software.md index ee0e99d..f7aee12 100644 --- a/docs/root/source/installation/node-setup/set-up-node-software.md +++ b/docs/root/source/installation/node-setup/set-up-node-software.md @@ -36,17 +36,17 @@ For example, to install version 2.2.2, you would do: ``` # Change 2.0.0 to the latest version as explained above: -sudo pip3 install bigchaindb==2.2.2 +sudo pip3 install planetmint==2.2.2 ``` -Check that you installed the correct version of Planetmint Server using `bigchaindb --version`. +Check that you installed the correct version of Planetmint Server using `planetmint --version`. ## Configure Planetmint Server To configure Planetmint Server, run: ``` -bigchaindb configure +planetmint configure ``` The first question is ``API Server bind? (default `localhost:9984`)``. @@ -58,7 +58,7 @@ The first question is ``API Server bind? (default `localhost:9984`)``. You can accept the default value for all other Planetmint config settings. If you're using NGINX, then you should edit your Planetmint config file -(in `$HOME/.bigchaindb` by default) and set the following values +(in `$HOME/.planetmint` by default) and set the following values under `"wsserver"`: ``` diff --git a/docs/root/source/installation/node-setup/troubleshooting.md b/docs/root/source/installation/node-setup/troubleshooting.md index 036046e..aa679c0 100644 --- a/docs/root/source/installation/node-setup/troubleshooting.md +++ b/docs/root/source/installation/node-setup/troubleshooting.md @@ -8,8 +8,8 @@ ## Tendermint Tips -* [Configure Tendermint to create no empty blocks](https://tendermint.com/docs/tendermint-core/using-tendermint.html#no-empty-blocks). -* Store the Tendermint data on a fast drive. You can do that by changing [the location of TMHOME](https://tendermint.com/docs/tendermint-core/using-tendermint.html#directory-root) to be on the fast drive. +* [Configure Tendermint to create no empty blocks](https://tendermint.io/docs/tendermint-core/using-tendermint.html#no-empty-blocks). +* Store the Tendermint data on a fast drive. You can do that by changing [the location of TMHOME](https://tendermint.io/docs/tendermint-core/using-tendermint.html#directory-root) to be on the fast drive. See the [Tendermint tips in the vrde/notes repository](https://github.com/vrde/notes/tree/master/tendermint). @@ -36,7 +36,7 @@ addr_book_strict = false If you want to refresh your node back to a fresh empty state, then your best bet is to terminate it and deploy a new machine, but if that's not an option, then you can: -* drop the `bigchain` database in MongoDB using `bigchaindb drop` (but that only works if MongoDB is running) +* drop the `planetmint` database in MongoDB using `planetmint drop` (but that only works if MongoDB is running) * reset Tendermint using `tendermint unsafe_reset_all` * delete the directory `$HOME/.tendermint` @@ -46,45 +46,45 @@ If you want to stop/kill Planetmint, you can do so by sending `SIGINT`, `SIGQUIT process(es). Depending on how you started Planetmint i.e. foreground or background. e.g. you started Planetmint in the background as mentioned above in the guide: ```bash -$ nohup bigchaindb start 2>&1 > bigchaindb.log & +$ nohup planetmint start 2>&1 > planetmint.log & $ # Check the PID of the main Planetmint process -$ ps -ef | grep bigchaindb - *