tighten docs

This commit is contained in:
Joachim Schlöffel
2026-07-05 23:21:24 +02:00
parent 1c4b598b5c
commit e076b3249a
3 changed files with 50 additions and 92 deletions
+17 -19
View File
@@ -1,23 +1,24 @@
# SeaweedFS Alpine Package
This package repackages the official SeaweedFS 4.31 Linux release tarballs for `x86_64` and `aarch64`. It installs the `weed` binary, short active config defaults, generated examples, bash completion, and split OpenRC service packages.
Repackages official SeaweedFS 4.31 Linux release tarballs for `x86_64` and
`aarch64`.
## Package Commands
Refresh generated config examples and bash completion after changing the SeaweedFS version or generated source flow:
Refresh generated sources:
```sh
ALPINE_PACKAGE=seaweedfs mise run apk:update-generated
ALPINE_PACKAGE=seaweedfs mise run apk:checksum
```
Build only this package:
Build:
```sh
ALPINE_PACKAGE=seaweedfs mise run apk:build
```
Install-test an existing local build without rebuilding:
Install-test local build:
```sh
ALPINE_PACKAGE=seaweedfs SKIP_BUILD=1 mise run apk:test-install
@@ -25,9 +26,7 @@ ALPINE_PACKAGE=seaweedfs SKIP_BUILD=1 mise run apk:test-install
## Install Node Roles
Install the base package plus only the OpenRC role packages needed on that node.
For a single-node test or a compact small deployment:
Single-node install:
```sh
apk add seaweedfs \
@@ -36,7 +35,7 @@ apk add seaweedfs \
seaweedfs-filer-openrc
```
For separated production nodes, install only the role running there:
Role-specific installs:
```sh
apk add seaweedfs seaweedfs-master-openrc
@@ -57,7 +56,7 @@ seaweedfs-admin-openrc -> /etc/init.d/seaweedfs.admin
seaweedfs-worker-openrc -> /etc/init.d/seaweedfs.worker
```
The package name is `seaweedfs`, matching Alpine aports. If a node already has Alpine's old generic OpenRC package installed, remove it before installing a role-specific split:
Replace Alpine's old generic OpenRC package before installing a role split:
```sh
apk del seaweedfs-openrc
@@ -66,7 +65,7 @@ apk add seaweedfs seaweedfs-master-openrc
## Configure Services
Runtime files are installed in the usual Alpine locations:
Runtime paths:
```text
/usr/bin/weed
@@ -75,13 +74,14 @@ Runtime files are installed in the usual Alpine locations:
/etc/init.d/seaweedfs.*
```
Edit `/etc/conf.d/seaweedfs.<role>` for command-line flags and `/etc/seaweedfs/*.toml` for SeaweedFS config. The packaged defaults are short and production-neutral; full upstream example configs are in:
Edit `/etc/conf.d/seaweedfs.<role>` for flags and `/etc/seaweedfs/*.toml` for
SeaweedFS config. Upstream examples:
```text
/usr/share/doc/seaweedfs/examples/
```
Enable and start only the services needed on the node:
Enable services:
```sh
rc-update add seaweedfs.master default
@@ -94,7 +94,7 @@ rc-update add seaweedfs.filer default
rc-service seaweedfs.filer start
```
Check the installed binary and service state:
Check status:
```sh
weed version
@@ -103,30 +103,28 @@ rc-service seaweedfs.master status
## Optional Packages
Install docs and generated examples:
Docs and examples:
```sh
apk add seaweedfs-doc
```
Install bash completion:
Bash completion:
```sh
apk add bash-completion seaweedfs-bash-completion
```
`seaweedfs-bash-completion` is also selected automatically when `seaweedfs` and `bash-completion` are installed together.
## Upgrade Or Pin
Use normal Alpine package operations:
Upgrade:
```sh
apk upgrade seaweedfs
rc-service seaweedfs.master restart
```
Pin a specific package build when needed:
Pin:
```sh
apk add seaweedfs=4.31-r3