Skip to content

Commit a25d8c3

Browse files
grishygrishy
committed
fix(docs): update README to include new environment variables for S3 and filenode storage limit
1 parent 358f0ed commit a25d8c3

1 file changed

Lines changed: 25 additions & 22 deletions

File tree

‎README.md‎

Lines changed: 25 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -124,16 +124,18 @@ Edit `ANY_SYNC_BUNDLE_INIT_EXTERNAL_ADDRS` in the compose file before starting.
124124

125125
### Quick Reference
126126

127-
| Variable | Purpose | Required |
128-
| ------------------------------------- | ------------------------------ | -------- |
129-
| `ANY_SYNC_BUNDLE_INIT_EXTERNAL_ADDRS` | Advertised addresses | Yes |
130-
| `ANY_SYNC_BUNDLE_INIT_MONGO_URI` | MongoDB connection | No |
131-
| `ANY_SYNC_BUNDLE_INIT_REDIS_URI` | Redis connection | No |
132-
| `ANY_SYNC_BUNDLE_INIT_S3_BUCKET` | S3 bucket name | No |
133-
| `ANY_SYNC_BUNDLE_INIT_S3_ENDPOINT` | S3 endpoint URL | No |
134-
| `ANY_SYNC_BUNDLE_INIT_S3_REGION` | S3 region (default: us-east-1) | No |
135-
| `AWS_ACCESS_KEY_ID` | S3 credentials | No |
136-
| `AWS_SECRET_ACCESS_KEY` | S3 credentials | No |
127+
| Variable | Purpose | Required |
128+
| --------------------------------------------- | -------------------------------- | -------- |
129+
| `ANY_SYNC_BUNDLE_INIT_EXTERNAL_ADDRS` | Advertised addresses | Yes |
130+
| `ANY_SYNC_BUNDLE_INIT_MONGO_URI` | MongoDB connection | No |
131+
| `ANY_SYNC_BUNDLE_INIT_REDIS_URI` | Redis connection | No |
132+
| `ANY_SYNC_BUNDLE_INIT_S3_BUCKET` | S3 bucket name | No |
133+
| `ANY_SYNC_BUNDLE_INIT_S3_ENDPOINT` | S3 endpoint URL | No |
134+
| `ANY_SYNC_BUNDLE_INIT_S3_REGION` | S3 region (default: us-east-1) | No |
135+
| `ANY_SYNC_BUNDLE_INIT_S3_FORCE_PATH_STYLE` | Path-style S3 URLs (for MinIO) | No |
136+
| `ANY_SYNC_BUNDLE_INIT_FILENODE_DEFAULT_LIMIT` | Storage limit per space in bytes | No |
137+
| `AWS_ACCESS_KEY_ID` | S3 credentials | No |
138+
| `AWS_SECRET_ACCESS_KEY` | S3 credentials | No |
137139

138140
### Configuration Files
139141

@@ -220,18 +222,19 @@ All parameters available as binary flags or environment variables. See `./any-sy
220222

221223
### Start Command Flags
222224

223-
| Flag | Description |
224-
| ------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
225-
| `--bundle-config`, `-c` | Path to the bundle configuration YAML file <br> ‣ Default: `./data/bundle-config.yml` <br> ‣ Environment Variable: `ANY_SYNC_BUNDLE_CONFIG` |
226-
| `--client-config`, `--cc` | Path where write to the Anytype client configuration YAML file if needed <br> ‣ Default: `./data/client-config.yml` <br> ‣ Environment Variable: `ANY_SYNC_BUNDLE_CLIENT_CONFIG` |
227-
| `--initial-storage` | Initial path to the bundle data directory (must be writable) <br> ‣ Default: `./data/storage/` <br> ‣ Environment Variable: `ANY_SYNC_BUNDLE_INIT_STORAGE` |
228-
| `--initial-external-addrs` | Initial external addresses for the bundle <br> ‣ Default: `192.168.8.214,example.local` <br> ‣ Environment Variable: `ANY_SYNC_BUNDLE_INIT_EXTERNAL_ADDRS` |
229-
| `--initial-mongo-uri` | Initial MongoDB URI for the bundle <br> ‣ Default: `mongodb://127.0.0.1:27017/` <br> ‣ Environment Variable: `ANY_SYNC_BUNDLE_INIT_MONGO_URI` |
230-
| `--initial-redis-uri` | Initial Redis URI for the bundle <br> ‣ Default: `redis://127.0.0.1:6379/` <br> ‣ Environment Variable: `ANY_SYNC_BUNDLE_INIT_REDIS_URI` |
231-
| `--initial-s3-bucket` | S3 bucket name <br> ‣ Environment Variable: `ANY_SYNC_BUNDLE_INIT_S3_BUCKET` |
232-
| `--initial-s3-endpoint` | S3 endpoint URL <br> ‣ Environment Variable: `ANY_SYNC_BUNDLE_INIT_S3_ENDPOINT` |
233-
| `--initial-s3-region` | S3 region for request signing <br> ‣ Default: `us-east-1` <br> ‣ Environment Variable: `ANY_SYNC_BUNDLE_INIT_S3_REGION` |
234-
| `--initial-s3-force-path-style` | Use path-style S3 URLs (required for MinIO) <br> ‣ Default: `false` <br> ‣ Environment Variable: `ANY_SYNC_BUNDLE_INIT_S3_FORCE_PATH_STYLE` |
225+
| Flag | Description |
226+
| ---------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
227+
| `--bundle-config`, `-c` | Path to the bundle configuration YAML file <br> ‣ Default: `./data/bundle-config.yml` <br> ‣ Environment Variable: `ANY_SYNC_BUNDLE_CONFIG` |
228+
| `--client-config`, `--cc` | Path where write to the Anytype client configuration YAML file if needed <br> ‣ Default: `./data/client-config.yml` <br> ‣ Environment Variable: `ANY_SYNC_BUNDLE_CLIENT_CONFIG` |
229+
| `--initial-storage` | Initial path to the bundle data directory (must be writable) <br> ‣ Default: `./data/storage/` <br> ‣ Environment Variable: `ANY_SYNC_BUNDLE_INIT_STORAGE` |
230+
| `--initial-external-addrs` | Initial external addresses for the bundle <br> ‣ Default: `192.168.8.214,example.local` <br> ‣ Environment Variable: `ANY_SYNC_BUNDLE_INIT_EXTERNAL_ADDRS` |
231+
| `--initial-mongo-uri` | Initial MongoDB URI for the bundle <br> ‣ Default: `mongodb://127.0.0.1:27017/` <br> ‣ Environment Variable: `ANY_SYNC_BUNDLE_INIT_MONGO_URI` |
232+
| `--initial-redis-uri` | Initial Redis URI for the bundle <br> ‣ Default: `redis://127.0.0.1:6379/` <br> ‣ Environment Variable: `ANY_SYNC_BUNDLE_INIT_REDIS_URI` |
233+
| `--initial-s3-bucket` | S3 bucket name <br> ‣ Environment Variable: `ANY_SYNC_BUNDLE_INIT_S3_BUCKET` |
234+
| `--initial-s3-endpoint` | S3 endpoint URL <br> ‣ Environment Variable: `ANY_SYNC_BUNDLE_INIT_S3_ENDPOINT` |
235+
| `--initial-s3-region` | S3 region for request signing <br> ‣ Default: `us-east-1` <br> ‣ Environment Variable: `ANY_SYNC_BUNDLE_INIT_S3_REGION` |
236+
| `--initial-s3-force-path-style` | Use path-style S3 URLs (required for MinIO) <br> ‣ Default: `false` <br> ‣ Environment Variable: `ANY_SYNC_BUNDLE_INIT_S3_FORCE_PATH_STYLE` |
237+
| `--initial-filenode-default-limit` | Storage limit per space in bytes <br> ‣ Default: `1099511627776` (1 TiB) <br> ‣ Environment Variable: `ANY_SYNC_BUNDLE_INIT_FILENODE_DEFAULT_LIMIT` |
235238

236239
## Operations
237240

0 commit comments

Comments
 (0)