mirror of
https://github.com/anyproto/any-sync-dockercompose.git
synced 2025-06-08 05:47:03 +09:00
Moved the documentation to the wiki
This commit is contained in:
Grigory Efimov
parent
9f30d1b508
commit
ec1e0bbedd
2 changed files with 6 additions and 176 deletions
138
README.md
138
README.md
|
|
@ -8,140 +8,14 @@ Self-host for any-sync, designed for personal usage or for review and testing pu
|
|||
> [!WARNING]
|
||||
> Before upgrading please read [UPGRADE.md](./UPGRADE.md)
|
||||
|
||||
## Table of Contents
|
||||
- [Prepare](#prepare)
|
||||
- [Usage](#usage)
|
||||
- [Configuration](#configuration)
|
||||
- [Troubleshooting](#troubleshooting)
|
||||
- [Compatible versions](#compatible-versions)
|
||||
- [Local build](#local-build)
|
||||
- [Upgrading](#upgrading)
|
||||
- [Changelog](#changelog)
|
||||
- [Contribution](#contribution)
|
||||
|
||||
## Prepare
|
||||
* install docker and docker-compose https://docs.docker.com/compose/install/linux/
|
||||
|
||||
## Usage
|
||||
* start stand - at the first run the directories `etc/` of configuration files and `storage/` for data storage will be generated:
|
||||
|
||||
For Linux, MacOS and other nix* systems:
|
||||
```
|
||||
make start
|
||||
```
|
||||
For Windows (Run this in PowerShell, not cmd.exe):
|
||||
```
|
||||
# Disable auto convert LF to CRLF
|
||||
# !!! run BEFORE clone repo !!!
|
||||
git config --global core.autocrlf false
|
||||
|
||||
# Generate config
|
||||
docker buildx build --tag generateconfig-env --file Dockerfile-generateconfig-env .
|
||||
docker run --rm --volume ${PWD}/:/code/ generateconfig-env
|
||||
# Run containers
|
||||
docker compose up -d
|
||||
```
|
||||
* stop stand:
|
||||
```
|
||||
make stop
|
||||
```
|
||||
* restart stand:
|
||||
```
|
||||
make restart
|
||||
```
|
||||
* update image versions and start:
|
||||
```
|
||||
make update
|
||||
```
|
||||
* clean unused docker objects:
|
||||
```
|
||||
make clean
|
||||
```
|
||||
* clean config and storage files - deleting data for redis, mongo, s3, any-sync-*:
|
||||
```
|
||||
make cleanEtcStorage
|
||||
```
|
||||
* show logs:
|
||||
```
|
||||
docker-compose logs -f any-sync-node
|
||||
docker-compose logs -f any-sync-filenode
|
||||
docker-compose logs -f
|
||||
```
|
||||
* attach to container:
|
||||
```
|
||||
docker compose exec mongo-1 bash
|
||||
docker compose exec any-sync-node-1 bash
|
||||
docker compose exec any-sync-coordinator bash
|
||||
```
|
||||
|
||||
* restart certain container:
|
||||
```
|
||||
docker compose restart any-sync-node-1
|
||||
```
|
||||
|
||||
* get current network config
|
||||
```
|
||||
docker compose exec mongo-1 mongosh 127.0.0.1:27001/coordinator
|
||||
db.getMongo().setReadPref('primaryPreferred'); db.nodeConf.find().sort( { _id: -1 } ).limit(1)
|
||||
```
|
||||
|
||||
* run client (GUI)
|
||||
Download client for [desktop](https://download.anytype.io/)
|
||||
Use `<pathToRepo>/etc/client.yml` as a network configuration for the clients.
|
||||
See [the documentation](https://doc.anytype.io/anytype-docs/data-and-security/self-hosting#switching-between-networks) for more details.
|
||||
|
||||
* run client (CLI)
|
||||
```
|
||||
# macos example
|
||||
ANYTYPE_LOG_LEVEL="*=DEBUG" ANYPROF=:6060 ANY_SYNC_NETWORK=$(pwd)/etc/client.yml /Applications/Anytype.app/Contents/MacOS/Anytype
|
||||
```
|
||||
|
||||
## Configuration
|
||||
> [!WARNING]
|
||||
> The .env file is generated automatically.
|
||||
It is based on the .env.common file, which is overridden or extended by variables from the .env.override file.
|
||||
### Version control
|
||||
By default, we use "prod" image version for any-sync-* daemons.
|
||||
Also you can use "stage1" or "latest" verions:
|
||||
```
|
||||
# for use stage1 version
|
||||
ln -F -s .env.override.stage1 .env.override
|
||||
# for use latest version
|
||||
ln -F -s .env.override.latest .env.override
|
||||
```
|
||||
### external listen host
|
||||
By default, we use only the listen address 127.0.0.1, which is sufficient for running tests and a local client.
|
||||
If you need to connect external clients, please add "EXTERNAL_LISTEN_HOSTS" in .env.override file.
|
||||
Use spaces separation, multiline is not supported. For example:
|
||||
```
|
||||
EXTERNAL_LISTEN_HOSTS=<yourExternalIp1> <yourExternalIp2 ...
|
||||
```
|
||||
|
||||
## [Troubleshooting & FAQ](../../wiki/Troubleshooting-&-FAQ#mongodb-requires-a-cpu-with-avx-support)
|
||||
|
||||
## Compatible versions
|
||||
You can find compatible versions on these pages:
|
||||
* stable versions, used in [production](https://puppetdoc.anytype.io/api/v1/prod-any-sync-compatible-versions/)
|
||||
* unstable versions, used in [test stand](https://puppetdoc.anytype.io/api/v1/stage1-any-sync-compatible-versions/)
|
||||
|
||||
## Local build
|
||||
If you need to create local build binaries for any-sync-*, you can do so by using the "overrides" functionality in docker-compose.
|
||||
|
||||
* clone repos
|
||||
```
|
||||
install -d repos && for REPO in any-sync-{node,filenode,coordinator,consensusnode}; do if [[ ! -d repos/$REPO ]]; then git clone git@github.com:anyproto/${REPO}.git repos/$REPO; fi; done
|
||||
```
|
||||
* to create a symlink for the "override file," you can either create it yourself as docker-compose.override.yml or use an existing one
|
||||
```
|
||||
ln -F -s docker-compose.any-sync-node-1.yml docker-compose.override.yml
|
||||
```
|
||||
* restart docker compose
|
||||
```
|
||||
make restart
|
||||
```
|
||||
## [Usage](../../wiki/)
|
||||
## [Configuration](../../wiki/Configuration)
|
||||
## [Troubleshooting & FAQ](../../wiki/Troubleshooting-&-FAQ)
|
||||
## [Compatible versions](../../wiki/Compatible-versions)
|
||||
## [Local build](../../wiki/Local-build)
|
||||
|
||||
## Upgrading
|
||||
For detailed instructions of upgrading to the latest version, please see the [UPGRADE.md](./UPGRADE.md) file.
|
||||
For detailed instructions of upgrading to the latest version, please see the [Upgrade-Guide](../../wiki/Upgrade-Guide) file.
|
||||
|
||||
## Changelog
|
||||
For a detailed list of changes in each version, check out the [CHANGELOG.md](./CHANGELOG.md) file.
|
||||
|
|
|
|||
44
UPGRADE.md
44
UPGRADE.md
|
|
@ -1,44 +0,0 @@
|
|||
# Upgrade Guide
|
||||
|
||||
This document provides detailed instructions for upgrading between different versions of the project.
|
||||
|
||||
## General Recommendations
|
||||
|
||||
- Always back up data dir (./storage) and configuration (./etc) before starting the upgrade process.
|
||||
- Follow the instructions for the specific version you are upgrading to.
|
||||
|
||||
## Generic Update Routine
|
||||
|
||||
### Before the Upgrade
|
||||
|
||||
1. Ensure you have a complete backup of your data and configuration.
|
||||
|
||||
### Upgrade Process
|
||||
|
||||
usually enough to run this update command ```make update```
|
||||
in some cases it may be necessary to run ```make upgrade```
|
||||
|
||||
|
||||
### After the Upgrade
|
||||
|
||||
1. Check logs for any errors. ```docker-compose logs -f```
|
||||
2. Verify that all critical functionalities are working as expected.
|
||||
|
||||
## Upgrading from v1.x.x to v2.x.x
|
||||
|
||||
Starting with version 2.0.1, we have switched from s3-emulator to MinIO for storing data uploaded via the any-sync-filenode daemon.
|
||||
To preserve your data, you will need to manually migrate it from s3-emulator to MinIO.
|
||||
For this You can use https://min.io/docs/minio/linux/reference/minio-mc/mc-mirror.html.
|
||||
|
||||
## Upgrading from v2.x.x to v3.x.x
|
||||
Starting with version 3.0.0, we have reduced mongo instances from 3 to 1.
|
||||
For correctly working You need reconfigure mongo cluster.
|
||||
After Upgrade please run:
|
||||
```
|
||||
docker compose exec mongo-1 mongosh --port 27001 --eval 'rs.reconfig({_id: rs.conf()._id, members: [{ _id: 0, host: "mongo-1:27001" }]}, {force: true});'
|
||||
```
|
||||
|
||||
## Upgrading from v3.x.x to v4.x.x
|
||||
1. You need to transfer your modifications from the .env file to the .env.override file.
|
||||
2. The variable EXTERNAL_LISTEN_HOST is deprecated.
|
||||
Please, use the variable EXTERNAL_LISTEN_HOSTS instead.
|
||||
Loading…
Add table
Add a link
Reference in a new issue