Skip to content

Add neova private-indexer tutorial to /how-to section and reference from privacy and enc page #2289

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
bumblefudge wants to merge 1 commit into
base: main
Choose a base branch
from
+473 −3
Open

Add neova private-indexer tutorial to /how-to section and reference from privacy and enc page #2289

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/.vuepress/config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -320,7 +320,8 @@ module.exports = {
sidebarDepth: 1,
collapsable: true,
children: [
['/how-to/privacy-best-practices', 'Privacy and Encryption'],
['/how-to/privacy-best-practices', 'Privacy and Encryption'],
['/how-to/private-indexer', 'Indexing a Private Network']
]
},
],
Expand Down
6 changes: 4 additions & 2 deletions docs/how-to/privacy-best-practices.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@

## Create a private network

Private IPFS networks provide full protection from public monitoring but can lack the scale benefits provided by the public IPFS network. A private network operates identically to the public one, but with one critical difference: it can only be accessed by nodes that have been given access, and it will only ever scale to those nodes. This means that the benefits of the public IPFS network's massive scale, such as geographic resiliency and speedy retrieval of high-demand content, won't be realized unless the private network is explicitly designed and scaled with this in mind.
Private IPFS networks provide full protection from public monitoring but can lack the scale benefits provided by the public IPFS network. A private network operates identically to the public one, but with one critical difference: it can only be accessed by nodes that have been given access, and it will only ever scale to those nodes. This means that the benefits of the public IPFS network's massive scale, such as geographic resiliency and speedy retrieval of high-demand content, won't be realized unless the private network is explicitly designed and scaled with this in mind. Each "private swarm" is a network onto itself, like a blockchain private network running the same virtual machine across permissioned actors.

Check failure on line 36 in docs/how-to/privacy-best-practices.md

View workflow job for this annotation

GitHub Actions / pr-content-check 

[vale] reported by reviewdog 🐶
[docs.PLNSpelling] Did you really mean 'permissioned'?

Raw Output:
{"message": "[docs.PLNSpelling] Did you really mean 'permissioned'?", "location": {"path": "docs/how-to/privacy-best-practices.md", "range": {"start": {"line": 36, "column": 704}}}, "severity": "ERROR"}

Running a private network can be a great option for corporate implementations of IPFS — for one example, see [this case study on Morpheus.Network](../case-studies/morpheus.md) — because the network's topology can be specified and built exactly as desired.
Running a private network can be a good fit for enterprise or "B2B" (business-to-business) implementations of IPFS — for one example, see [this case study on Morpheus.Network](../case-studies/morpheus.md) — because the network's topology can be specified and scaled according to the shape of a given ecosystem's information flows. Private networks can be architected to provide as much or as little redundancy, geographical distribution, and observability as required by the situation.

Check failure on line 38 in docs/how-to/privacy-best-practices.md

View workflow job for this annotation

GitHub Actions / pr-content-check 

[vale] reported by reviewdog 🐶
[docs.PLNSpelling] Did you really mean 'architected'?

Raw Output:
{"message": "[docs.PLNSpelling] Did you really mean 'architected'?", "location": {"path": "docs/how-to/privacy-best-practices.md", "range": {"start": {"line": 38, "column": 356}}}, "severity": "ERROR"}

Some implementers have even used a private IPFS network as a kind of "logical storage" for data encrypted at higher levels, making it a kind of oblivious data fabric (see [this case study on Vereign](../case-studies/vereign/#how-vereign-uses-ipfs). Since private nodes only share routing information to other permissioned and authenticated nodes, you can architect in custom routing and indexing to suit the use-case; see [this tutorial on indexing and routing with a private swarm](../how-to/private-indexer.md).

Check failure on line 40 in docs/how-to/privacy-best-practices.md

View workflow job for this annotation

GitHub Actions / pr-content-check 

[vale] reported by reviewdog 🐶
[docs.PLNSpelling] Did you really mean 'permissioned'?

Raw Output:
{"message": "[docs.PLNSpelling] Did you really mean 'permissioned'?", "location": {"path": "docs/how-to/privacy-best-practices.md", "range": {"start": {"line": 40, "column": 310}}}, "severity": "ERROR"}
Loading
Loading