anyproto/docs
1
0
Fork 0
mirror of https://github.com/anyproto/docs.git synced 2025-06-08 05:47:05 +09:00
Code Activity

GITBOOK-433: Update network info

Browse source
This commit is contained in:
Filip Bozicevic 2023-12-29 12:31:53 +00:00 • committed by gitbook-bot
parent 6d374f5565
commit 32d7692294
No known key found for this signature in database
GPG key ID: 07D2180C7B12D0FF
5 changed files with 57 additions and 132 deletions
Download patch file Download diff file Expand all files Collapse all files

5
SUMMARY.md
View file

@ -64,9 +64,8 @@
* [Recovery Phrase](data-and-security/what-is-a-recovery-phrase.md)
* [Privacy & Encryption](data-and-security/how-we-keep-your-data-safe.md)
* [Storage & Deletion](data-and-security/data-storage-and-deletion/README.md)
* [Backup & Self-Hosting](data-and-security/data-storage-and-deletion/self-hosting.md)
* [Local-only Mode](data-and-security/data-storage-and-deletion/local-only-mode.md)
* [Storage & Deletion](data-and-security/data-storage-and-deletion.md)
* [Networks & Backup](data-and-security/self-hosting.md)
* [Data Erasure](data-and-security/delete-or-reset-your-account.md)
* [Analytics & Tracking](data-and-security/analytics-and-tracking.md)

8
data-and-security/data-storage-and-deletion/README.md → data-and-security/data-storage-and-deletion.md
View file

@ -2,7 +2,7 @@
### Storage <a href="#storage" id="storage"></a>
Anytype is offline first; hence, all data you create will be stored locally first. After that, the data is synced to the backup node and your devices for redundancy. We use a private [IPFS](https://docs.ipfs.tech/concepts/what-is-ipfs/) network to handle storage. It is a Peer-To-Peer file system that facilitates decentralized data storage across devices. If you wish to bypass the backup node and sync directly (p2p) between your devices, you'll need to connect them to the same local network.
Anytype is offline first; hence, all data you create will be stored locally first. After that, the data is synced to the backup node and your devices for redundancy. We use a private [IPFS](https://docs.ipfs.tech/concepts/what-is-ipfs/) network to handle storage. It is a Peer-To-Peer file system that facilitates decentralized data storage across devices. Local P2P is supported, meaning that you can sync between your devices directly if they are connected through the same local network. This will work no matter what network mode you use, and it's the only way to sync between your devices if you are using local-only mode.
{% hint style="info" %}
Currently, you can not change the directory of your local data storage. We have it in [plans for Q3 2023](https://github.com/orgs/anyproto/projects/1/views/1). You might consider using a [workaround from our user](https://community.anytype.io/t/custom-storage-location/994) as a temporary solution for Windows and MacOS.
@ -10,7 +10,7 @@ Currently, you can not change the directory of your local data storage. We have
#### Media <a href="#media" id="media"></a>
Media files are not directly downloaded in overall syncing to save bandwidth. Instead, when that file is requested, it is streamed to your device from the backup node or your devices on the network. For example, if you have a 4K Video, it will be streamed from the backup node or P2P devices to your device. So when you open an object with an image, it downloads. When you press play on video & audio, it begins to download. After that, this file will be stored in the application cache.&#x20;
Media files are not directly downloaded in overall syncing to save bandwidth. Instead, when that file is requested, it is streamed to your device from the backup node or your devices on the network. For example, if you have a 4K Video, it will be streamed from the backup node or P2P devices to your device. So when you open an object with an image, it downloads. When you press play on video & audio, it begins to download. After that, this file will be stored in the application cache.
Furthermore, we use the deduplication feature to reduce storage. For example, if the same picture is uploaded three times, there is only one image copy stored to reduce storage consumption.
@ -24,8 +24,8 @@ Because of a legacy file system, some files might disappear from your graph if t
<figure><img src="https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FJbcKxgThRdSa4vZyLbvH%2Fuploads%2Fgit-blob-dcb526128401892f1a4773091dbf735febb4a875%2FScreenshot%202021-11-02%20at%2016.25.23.png?alt=media" alt=""><figcaption><p>Complete deletion in Bin</p></figcaption></figure>
At the moment you can only delete the Objects that you've created inside Anytype. At first, you can move them to the bin. Secondly, you can remove them completely from all devices. All your devices will also delete them when getting online. This action is irreversible, so please be careful.&#x20;
At the moment you can only delete the Objects that you've created inside Anytype. At first, you can move them to the bin. Secondly, you can remove them completely from all devices. All your devices will also delete them when getting online. This action is irreversible, so please be careful.
The deleted objects are still accessible in read-only mode, either from the bin, or through previously added links. You are also able to restore these objects directly through the read-only mode without needing to go through the bin.
Types and relations created by Anytype can't be deleted at the moment, but might be deletable in future releases.&#x20;
Types and relations created by Anytype can't be deleted at the moment, but might be deletable in future releases.

102
data-and-security/data-storage-and-deletion/local-only-mode.md
View file

@ -1,102 +0,0 @@
# Local-only Mode
<figure><img src="../../.gitbook/assets/image (2).png" alt=""><figcaption></figcaption></figure>
### Switching to Local-only mode <a href="#docs-internal-guid-b8474bf5-7fff-883b-ea7e-2e4905cc9a00" id="docs-internal-guid-b8474bf5-7fff-883b-ea7e-2e4905cc9a00"></a>
To turn off backing up of your spaces and data, you need to turn on local-only mode. Please note that all your devices should be manually switched to local-only mode.
#### Desktop
1. Log out from your current identity.
2. On the onboarding screen, click a gear icon in the top right corner.
3. In the “Network” field choose the “Local-only” option.
4. Click the “Save” button.
Now you can create a new identity or log in with the existing one.
#### iOS
1. Log out from your current identity.
2. On the onboarding screen, click a gear icon in the top right corner.
3. Click the “Local-only” button.
Now you can create a new identity or log in with the existing one.
#### Android
1. Log out from your current identity.
2. Go to the app settings on the system level (hold the app icon, click “App info”, then go to “Additional app setting”; this flow can differ depending on your Android device).
3. In the “Network” field choose the “Local-only” option.
4. Go back to the app.
Now you can create a new identity or log in with the existing one.
### Switching back to Anytype Network
To backup your spaces and data to the Anytype Network, you need to manually switch all your devices to Anytype Network mode.
We strongly recommend using dedicated identities for each network. If you are switching from a Self-hosted network, export all your spaces, and import them into a new identity after switching the network mode.
#### Desktop
1. Log out from your current identity.
2. On the onboarding screen, click a gear icon in the top right corner.
3. In the “Network” field choose the “Anytype Network” option.
4. Click the “Save” button.
Now you can create a new identity or log in with the one existing in Anytype Network.
#### iOS
1. Log out from your current identity.
2. On the onboarding screen, click a gear icon in the top right corner.
3. Click the “Anytype Network” button.
Now you can create a new identity or log in with the one existing in Anytype Network.
#### Android
1. Log out from your current identity.
2. Go to the app settings on the system level (hold the app icon, click “App info”, then go to “Additional app setting”; this flow can differ depending on your Android device).
3. In the “Network” field choose the “Anytype Network” option.
4. Go back to the app
Now you can create a new identity or log in with the one existing in Anytype Network.
### Switching to Self-hosted network
To backup your spaces and data to a self-hosted network, you need to have a network configuration. If you don’t run your own network yet, see this [how-to guide](https://tech.anytype.io/how-to/self-hosting).
We strongly recommend using dedicated identities for each network. If you already have an identity in Anytype Network and want to switch to a self-hosted network, export all your spaces, and import them into a new identity after switching the network mode.
Please note that all your devices should be manually switched to the same self-hosted network.
#### Desktop
1. Log out from your current identity.
2. On the onboarding screen, click a gear icon in the top right corner.
3. In the “Network” field choose the “Self-hosted” option.
4. Upload your self-hosted network configuration (\*.yml file) to the corresponding field.
5. Click the “Save” button.
Now you can create a new identity or log in with the one existing in your self-hosted network.
#### iOS
1. Log out from your current identity.
2. On the onboarding screen, click a gear icon in the top right corner.
3. Click the “Add self-hosted network” button.
4. Choose your self-hosted network configuration (\*.yml file).
Now you can create a new identity or log in with the one existing in your self-hosted network.
#### Android
1. Log out from your current identity.
2. Go to the app settings on the system level (hold the app icon, click “App info”, then go to “Additional app setting”; this flow can differ depending on your Android device).
3. In the “Network” field choose the “Self-hosted” option.
4. Upload your self-hosted network configuration (\*.yml file) to the corresponding field.
5. Go back to the app.
Now you can create a new identity or log in with the one existing in your self-hosted network.

23
data-and-security/data-storage-and-deletion/self-hosting.md
View file

@ -1,23 +0,0 @@
# Backup & Self-Hosting
## Backup node
Every Anytype user has access to a remote backup node provided by Anytype. Its capacity is currently limited to 1 Gb. Objects and other content have no impact on this limit; only files are limited. If you go over the limit, a warning will appear, and you'll be able to ask for more storage.
Our backup nodes are located in Switzerland.
We plan on introducing third-party sync providers in the future.
#### Disable the Anytype backup node
There is currently no option in the account settings to disable the backup node, but this is something we are planning on [introducing soon](https://github.com/orgs/anyproto/projects/1/views/1?pane=issue\&itemId=34713319).
Alternatively, you can [block Anytype network traffic](https://community.anytype.io/t/is-there-a-way-to-limit-storage-of-data-only-local/6982) (Anytype & Anytype Helper) via your firewall.
## **How to self-host Anytype**
If you don’t want to use Anytype backup node, you can self-host your own using [this guide](https://tech.anytype.io/how-to/self-hosting). It is our first step in this direction, so it requires some technical skills from users and depends on several external solutions.
Our contributors are already working on creating a Docker image to simplify the setup of self-hosted infrastructure. You can join by following this [discussion](https://github.com/orgs/anyproto/discussions/17) on our GitHub page.
Internally, we're already working on adding network configuration ability into the apps. This will make the process of rebuilding clients optional and greatly simplify the self-hosting flow. We expect to deliver this feature in upcoming releases.

51
data-and-security/self-hosting.md Normal file
View file

@ -0,0 +1,51 @@
# Networks & Backup
<figure><img src="../.gitbook/assets/image (2).png" alt=""><figcaption></figcaption></figure>
### Anytype Network
Every Anytype user has access to a remote backup node provided by Anytype. Its capacity is currently limited to 1 Gb. Objects and other content have no impact on this limit; only files are limited. If you go over the limit, a warning will appear, and you'll be able to ask for more storage.
Our backup nodes are located in Switzerland.
### **Self-hosted Network**
To backup your spaces and data to a self-hosted network, you need to have a network configuration. If you don’t run your own network yet, see this [how-to guide](https://tech.anytype.io/how-to/self-hosting).
Our contributors are already working on creating a Docker image to simplify the setup of self-hosted infrastructure. You can join by following this [discussion](https://github.com/orgs/anyproto/discussions/17) on our GitHub page.
### Local-only Mode
If you don't want to use any backup solutions at all, you can use our local-only mode. This will disable the backup node completely, and you will only be able to sync between your devices if they are connected to the same local network. Regularly exporting your spaces is recommended if you decide to use this mode since your data is not backed up anywhere.
### Switching Between Networks
We strongly recommend using dedicated identities for each network. If you are switching from a different network, export all your spaces, and import them into a new identity after switching the network mode.
Please note that all your devices should be manually switched to the same network.
#### Desktop
1. Log out from your current identity.
2. On the onboarding screen, click a gear icon in the top right corner.
3. In the “Network” field pick the network mode you want to use.
4. If you picked the “Self-hosted” mode, upload your self-hosted network configuration (\*.yml file) to the corresponding field.
5. Click the “Save” button.
6. Create a new identity or log in with the existing one.
#### iOS
1. Log out from your current identity.
2. On the onboarding screen, click a gear icon in the top right corner.
3. Click on the network mode you want to use.
4. If you can't find your network in the list, you can add one by clicking the “Add self-hosted network” button, and choosing your self-hosted network configuration (\*.yml file).
5. Create a new identity or log in with the existing one.
#### Android
1. Log out from your current identity.
2. Go to the app settings on the system level (hold the app icon, click “App info”, then go to “Additional app setting”; this flow can differ depending on your Android device).
3. In the “Network” field pick the network mode you want to use.
4. If you picked the “Self-hosted” mode, upload your self-hosted network configuration (\*.yml file) to the corresponding field.
5. Go back to the app.
6. Create a new identity or log in with the existing one.