joopschilder/zmq-fileserver
joopschilder/zmq-fileserver
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Add 'README.md'

Browse Source
This commit is contained in:
Joop Schilder 2020-06-20 18:29:09 +02:00
parent ae7f92d51d
commit 906fe39e39
1 changed files with 29 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
README.md Normal file
View File

@ -0,0 +1,29 @@
# `zmq-fileserver`
This is a simple fileserver written in PHP (7.4+) using [ZeroMQ](https://zeromq.org/).
There are three executable files:
- `$ ./server` runs the fileserver
- `$ ./command <arg1> <arg2> ...` sends a command to the server
- `$ ./query <arg1> <arg2> ...` sends a query to the server and returns the response
## Commands
- `SAVE <namespace> <name> <contents>` saves a file
- `DELETE <namespace> <name>` deletes a file if it exists
- `DELETE_ALL <namespace>` deletes an entire namespace
To save a file to the fileserver you can do:
`$ ./command SAVE my-project-namespace 1.html "<!DOCTYPE html><html>...</html>"`
`$ ./command SAVE my-project-namespace 2.xml "$(cat some/xml/file)"`
## Queries
- `CONTAINS <namespace> <name>` returns `Y` if the file exists in the namespace, else `N`
- `LOAD <namespace> <name>` returns the file contents if it exists, else `-1`
To load a file from the fileserver you can do:
`$ ./query LOAD my-project-namespace 1.html`