Merge pull request #189 from anyproto/update-readme

upd README.md

Author: fb929

README.md

@@ -1,45 +1,109 @@
-# Docker-compose for any-sync
-Self-host for any-sync, designed for personal usage or for review and testing purposes.
+# Docker Compose for any-sync
+
+A self-hosted any-sync network, designed for personal use, review, or testing purposes.
 
 > [!IMPORTANT]
-> This image is suitable for running your personal self-hosted any-sync network for home use.
-> If you plan to self-host a heavily used any-sync network, please consider using other options, such as a [Puppet](https://github.com/anyproto/puppet-anysync) or [Ansible](https://github.com/anyproto/ansible-anysync) module.
+> This setup is suitable for personal self-hosted any-sync networks.
+> For high-load production deployments, consider using the [Puppet](https://github.com/anyproto/puppet-anysync) or [Ansible](https://github.com/anyproto/ansible-anysync) modules.
 
 > [!WARNING]
-> Before upgrading please read [Upgrade-Guide](../../wiki/Upgrade-Guide)
+> Before upgrading, read the [Upgrade Guide](../../wiki/Upgrade-Guide).
 
-## Documentation
-All of the documentation for this repository is located in the [Wiki](../../wiki).  
-Please visit the Wiki for comprehensive guides, installation instructions and more.
+## Requirements
+
+- [Docker](https://docs.docker.com/compose/install/) with Compose plugin v2+
+- ~1 GB RAM available
+
+## Architecture
+
+The stack runs the following services:
+
+| Service | Role | Depends on |
+|---|---|---|
+| `any-sync-coordinator` | Network coordinator, manages spaces and members | MongoDB |
+| `any-sync-node` ×3 | Document sync nodes | coordinator |
+| `any-sync-filenode` | File storage node | coordinator, MinIO, Redis |
+| `any-sync-consensusnode` | Consensus for conflict resolution | coordinator |
+| `netcheck` | Periodic connectivity health monitor | all nodes |
+| MongoDB | Coordinator state | — |
+| Redis | Filenode index | — |
+| MinIO | S3-compatible object storage for files | — |
+
+Optional service: `anytype-cli` (commented out in `docker-compose.yml`) — HTTP/gRPC API server for automation.
 
 ## Getting Started
-To get started, follow these steps:
-
-1. **Install the necessary dependencies:**  
-    You need to install Docker and Docker Compose https://docs.docker.com/compose/install/
-2. **Clone the repository:**
-    ```bash
-    git clone https://github.com/anyproto/any-sync-dockercompose.git
-    ```
-3. **Navigate to the project directory:**
-    ```bash
-    cd any-sync-dockercompose
-    ```
-4. **Configuration:**  
-    For configuration, use the `.env.override` file.  
-    For example, setting an external IP for listening:
-    ```bash
-    echo 'EXTERNAL_LISTEN_HOSTS="<yourExternalIp1> <yourExternalIp2>"' >> .env.override
-    ```
-    More information can be found [here](../../wiki/Configuration).
-5. **Run the project:**
-    ```bash
-    make start
-    ```
-
-For detailed instructions, please refer to the [Usage Guide](../../wiki/Usage) in the Wiki.
+
+1. **Clone the repository:**
+   ```bash
+   git clone https://github.com/anyproto/any-sync-dockercompose.git
+   cd any-sync-dockercompose
+   ```
+
+2. **Configure** (optional — skip for local-only use):
+   ```bash
+   # Expose to an external IP:
+   echo 'EXTERNAL_LISTEN_HOSTS="<yourExternalIp>"' >> .env.override
+   ```
+   See [Configuration](../../wiki/Configuration) for all options.
+
+3. **Start:**
+   ```bash
+   make start
+   ```
+   On first run this generates configs in `./etc/` and starts all services.
+
+4. **Connect Anytype client:**
+   Upload `./etc/client.yml` to the Anytype app as your self-hosted network config.
+   See [Anytype docs](https://doc.anytype.io/anytype-docs/data-and-security/self-hosting#switching-between-networks).
+
+## Configuration
+
+| File | Purpose |
+|---|---|
+| `.env.default` | Default values — **do not edit** |
+| `.env` | Generated file — **do not edit** |
+| `.env.override` | Your customizations — edit this |
+
+Common overrides:
+
+```bash
+# External IP(s) for clients outside localhost
+EXTERNAL_LISTEN_HOSTS="1.2.3.4"
+
+# Custom storage path (default: ./storage)
+STORAGE_DIR="/mnt/data/any-sync"
+
+# Per-daemon memory limit (default: 500M)
+ANY_SYNC_DAEMONS_MEMORY_LIMIT=1G
+```
+
+Full reference: [Configuration Wiki](../../wiki/Configuration).
+
+## Quick Reference
+
+```bash
+make start      # Generate config and start all services
+make stop       # Stop services (data preserved)
+make restart    # Stop and start again
+make logs       # Follow logs from all services
+make pull       # Pull latest Docker images
+make update     # pull + restart (rolling update)
+make upgrade    # ⚠️  Full reset: removes containers and volumes, then starts fresh
+make down       # Stop and remove containers (data preserved)
+make clean      # ⚠️  docker system prune --all --volumes (removes all Docker data)
+make cleanEtcStorage  # Remove generated ./etc/ configs and ./storage/
+```
+
+## Documentation
+
+Full guides are in the [Wiki](../../wiki):
+- [Usage Guide](../../wiki/Usage)
+- [Configuration](../../wiki/Configuration)
+- [Upgrade Guide](../../wiki/Upgrade-Guide)
+- [Anytype CLI](../../wiki/Anytype-cli)
 
 ## Contribution
+
 Thank you for your desire to develop Anytype together!
 
 ❤️ This project and everyone involved in it is governed by the [Code of Conduct](https://github.com/anyproto/.github/blob/main/docs/CODE_OF_CONDUCT.md).