1.2.1 • Published 8 years ago
swarm-server v1.2.1
Swarm: a basic server
A simple LevelDB-backed WebSocket and TCP-listening Swarm server (peer).
Usage
swarmd [-C|-F|-A|-R] [options] path/database-id
C, F, A, R are run modes (create, fork, access, run). The database directory name consists of the database id and peer id.
npm install -g swarm-server
# creates an empty "test" database replica (peer id 1) at ./test-1
swarmd -C --oClock=Logical ./test-1
# WebSocket-only Swarm server, runs REPL, which is good for debugging
swarmd -R ./test-1 --listen ws://localhost:8080
Options
-C --create
create a database (dir name == db name)-n --name
database name (default: take from the path)-i --id XY
replica id (default: take from the path)--oXxx="Yyy"
set a global database option Xxx to "Yyy"--OXxx="Yyy"
set a scoped database option--0Xxx="Yyy"
set a local database option override
-F --fork
fork a database-t --to /path/dbname-YZ
a path for the new replica-i --id YZ
as above
-A --access
access a database-s --scan /Type#id!prefix
list all records under a prefix-e --erase /Type#id!prefix
erase records-p --put file
add ops to the database (default: read stdin)-v --vv
print the version vector-g --get /Type#id
print the object's state--OXxx, --0Xxx
edit database options (as above)
-U --user
add/remove/list users/clients-a --add login
add a user (take the password from stdin)-r --remove login
-l --list
-R --run
run a database (the default)-l --listen scheme:url
listen for client conns on URL-
stdin (default)ws://hostname:port
WebSockettcp://11.22.33.44:5555
TCP
-c --connect scheme:url
connect to a peer-e --exec script.js
execute a script once connected-r --repl
start REPL-d --daemon
daemonize-x
exit when done-f --filter
grep log events (e.g.-f /Swarm.on.off
)
Database options
- Globals (relayed to every replica)
DBIdScheme
replica id scheme (e.g.--oIdScheme=0280
)Clock
clock mode (Logical
,Hybrid
)ClockLen
minimum time value length (e.g. 6 for1GDBdW
)
- Scopeds (relayed to clients, but not peers)
- Locals (not relayed)
Listen
listen url (e.g.-0Listen=wss://swarmdb.net:1234
)Connect
peer's url (e.g.-0Connect=tcp://1.2.3.4:5678
)
for a CLI client, see swarm-client
.