any-sync-bundle

command module
v0.5.1-0...-982e324 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 31, 2025 License: MIT Imports: 6 Imported by: 0

README

Any-Sync-Bundle

Status Maintained
Version GitHub tag
CI/CD Build Status

TL;DR – How to start a self-hosted Anytype server

Replace the external address (e.g., 192.168.100.9) with a local IP address or domain.
Multiple addresses can be added, separated by commas.
Then use the client config YAML in ./data/client-config.yml.

docker run -d \
    -e ANY_SYNC_BUNDLE_INIT_EXTERNAL_ADDRS="192.168.100.9" \
    -p 33010-33013:33010-33013 \
    -p 33020-33023:33020-33023/udp \
    -v $(pwd)/data:/data \
    --restart unless-stopped \
    --name any-sync-bundle \
  ghcr.io/grishy/any-sync-bundle:latest

Version

Bundle version

The project version combines the bundle version and the original Anytype version.
Example: v0.5.0+2024-12-18

  • v0.5.0 – The bundle’s semver version
  • 2024-12-18 – The Anytype any-sync compatibility version from anytype.io
Bundle start version
  1. Binary file for each release on the Release page
  2. All-in-one container on ghcr.io/grishy/any-sync-bundle with Mongo and Redis included
  3. Minimal container (-minimal) with only any-sync-bundle, without Mongo or Redis

Key features

  • Easy to start: A single command to launch the server
  • All-in-one option: All services in a single container or in separate binaries
  • Lightweight: No MinIO included, and plans exist to reduce size further

Why created?

  1. Existing solutions required many containers and complicated config
  2. MinIO was too large for some servers
  3. Documentation and generated configs were incomplete

Issues on Anytype side in work to improve bundle

  1. https://github.com/anyproto/any-sync/issues/373
  2. https://github.com/anyproto/any-sync-dockercompose/issues/126
  3. https://github.com/anyproto/any-sync/pull/374
  4. Add API support for end users to retrieve notes
  5. The Anytype app supports only .yml files, not .yaml: https://github.com/anyproto/anytype-ts/pull/1186

Release

Reminder for releasing a new version.

# 1. Check locally
goreleaser release --snapshot --clean
# 1. Set variables (fish-shell)
set VERSION v0.5.0
set ANYTYPE_UNIX_TIMESTAMP 1734517522

# 2. Format date
set ANYTYPE_FORMATTED (date -r $ANYTYPE_UNIX_TIMESTAMP +'%Y-%m-%d')
set FINAL_VERSION $VERSION+$ANYTYPE_FORMATTED

# 3. Create tag and push
git tag -a $FINAL_VERSION -m "Release $FINAL_VERSION"
git push origin tag $FINAL_VERSION

Because I stand on the shoulders of giants, I can see further than they can.

License

© 2025 Sergei G.
Licensed under MIT.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
component
Package config build on top of https://github.com/anyproto/any-sync-tools/tree/72b131eaf4d6dc299ecf87dad60648e68054b35a/anyconf
Package config build on top of https://github.com/anyproto/any-sync-tools/tree/72b131eaf4d6dc299ecf87dad60648e68054b35a/anyconf

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL