docs: fileserver directory listing example

Author: yoursunny

Dockerfile

@@ -15,11 +15,12 @@ RUN export PATH=$PATH:/usr/local/go/bin && \
     env ${MAKE_ENV} make && \
     make install
 RUN rm -rf \
+      /usr/local/bin/__pycache__ \
       /usr/local/bin/dpdk-dumpcap \
       /usr/local/bin/dpdk-pdump \
       /usr/local/bin/dpdk-proc-info \
       /usr/local/bin/dpdk-test* \
-      /usr/local/bin/ninja \
+      /usr/local/bin/meson \
       /usr/local/bin/pip* \
       /usr/local/bin/spdk_* \
       /usr/local/bin/wheel \
@@ -31,7 +32,11 @@ RUN rm -rf \
       /usr/local/lib/python* \
       /usr/local/lib/systemd \
       /usr/local/man \
+      /usr/local/sbin \
       /usr/local/share/dpdk \
+      /usr/local/share/man \
+      /usr/local/share/polkit-1 \
+      /usr/local/share/xdp-tools \
       /usr/local/src && \
     for F in /usr/local/lib/*.so /usr/local/bin/*; do \
       ldd "$F" 2>/dev/null | awk 'NF==4 && $2=="=>" && $3~"^/" {print $3}'; \

docs/fileserver.md

@@ -115,11 +115,16 @@ sudo ndndpdk-ctrl --gqlserver http://127.0.0.1:3031 systemd start
 ```
 
 If you are running [NDN-DPDK in Docker container](Docker.md), start another container from the same NDN-DPDK image.
-The `/run/ndn` directory should be mounted into both containers in order to establish memif connection.
-In this case, you should change `--gqlserver` flag to target the container.
+The `/run/ndn` directory should be mounted into both containers in order to establish memif connection; you also need to change `--gqlserver` flag and `NDNTS_NDNDPDK_GQLSERVER` environment variable to target the container.
+Moreover, any folders that you want to serve from the NDN-DPDK file server should be mounted into the container; however, this isn't necessary in this example.
 
 The sample activation parameters given in [NDN-DPDK activation sample](../sample/activate) may be used in this scenario.
-Follow the instructions in the sample, then run `corepack pnpm start -s fileserver-args.ts | ndndpdk-ctrl --gqlserver http://127.0.0.1:3031 activate-fileserver` to send a file server activation command.
+Follow the instructions in the sample, then send a file server activation command with this command:
+
+```bash
+corepack pnpm -s start fileserver-args.ts | ndndpdk-ctrl --gqlserver http://127.0.0.1:3031 activate-fileserver
+```
+
 Notice the `--gqlserver` flag, targeting the second NDN-DPDK service instance.
 
 ### Retrieve the File
@@ -142,10 +147,38 @@ Example command and output:
 ```shell
 $ export NDNTS_UPLINK=ndndpdk-udp:
 $ export NDNTS_NDNDPDK_GQLSERVER=http://127.0.0.1:3030
-$ npx -y -p https://ndnts-nightly.ndn.today/cat.tgz ndncat get-segmented \
-    --ver=rdr /fileserver/usr-local-bin/ndndpdk-svc > /tmp/ndndpdk-svc.retrieved
+$ alias ndncat='npx -y -p https://ndnts-nightly.ndn.today/cat.tgz ndncat'
+
+$ ndncat get-segmented --ver=rdr /fileserver/usr-local-bin/ndndpdk-svc > /tmp/ndndpdk-svc.retrieved
 
 $ sha256sum /usr/local/bin/ndndpdk-svc /tmp/ndndpdk-svc.retrieved
 d7d68600dd33a2e344bb4e4895e10302d4f9781930b601241d5ec5aaacab6392  /usr/local/bin/ndndpdk-svc
 d7d68600dd33a2e344bb4e4895e10302d4f9781930b601241d5ec5aaacab6392  /tmp/ndndpdk-svc.retrieved
+
+$ ndncat file-client /fileserver/usr-local-bin /tmp/usr-local-bin-retrieved
+```
+
+### Retrieve a Directory
+
+NDN-DPDK file server also supports directory listing as defined in the [ndn6-file-server protocol](https://github.com/yoursunny/ndn6-tools/blob/main/file-server.md).
+You can use the [ndncat command](https://ndnts-docs.ndn.today/typedoc/modules/cat.html) to view the directory listing or recursively retrieve a directory.
+
+Example command and (partial) output:
+
+```shell
+$ $ ndncat get-segmented --ver=rdr /fileserver/usr-local-share/32=ls | tr '\0' '\n'
+ca-certificates/
+bash-completion/
+ndn-dpdk/
+
+$ ndncat get-segmented --ver=rdr /fileserver/usr-local-share/ndn-dpdk/32=ls | tr '\0' '\n'
+locator.schema.json
+ndn-dpdk.npm.tgz
+fileserver.schema.json
+
+$ ndncat file-client /fileserver/usr-local-share/ndn-dpdk /tmp/usr-local-share/ndn-dpdk
+FOLDER /tmp/usr-local-share/ndn-dpdk folders=0 files=7
+FILE /tmp/usr-local-share/ndn-dpdk/locator.schema.json size=8210
+FILE /tmp/usr-local-share/ndn-dpdk/ndn-dpdk.npm.tgz size=10980
+FILE /tmp/usr-local-share/ndn-dpdk/fileserver.schema.json size=22270
 ```

docs/trafficgen.md

@@ -106,7 +106,7 @@ You may use `ndndpdk-ctrl stop-trafficgen` command or GraphQL `delete` mutation
 Sample commands:
 
 ```bash
-TGID=$(corepack pnpm start -s gen-config.ts | ndndpdk-ctrl start-trafficgen | tee /dev/stderr | jq -r '.id')
+TGID=$(corepack pnpm -s start gen-config.ts | ndndpdk-ctrl start-trafficgen | tee /dev/stderr | jq -r '.id')
 ndndpdk-ctrl watch-trafficgen --id $TGID
 ndndpdk-ctrl stop-trafficgen --id $TGID
 ```

sample/activate/README.md

@@ -16,26 +16,26 @@ This is a Node.js application that generates activation parameters for NDN-DPDK
 4. Open a `.ts` file in the editor, and make changes.
    The editor can provide hints on available options.
 5. Run `corepack pnpm typecheck` to verify your arguments conform to the TypeScript definitions.
-6. Run `corepack pnpm start -s [filename] | jq` to see the JSON document.
-7. Run `corepack pnpm start -s [filename] | ndndpdk-ctrl [subcommand]` to send the activation command to NDN-DPDK.
+6. Run `corepack pnpm -s start [filename] | jq` to see the JSON document.
+7. Run `corepack pnpm -s start [filename] | ndndpdk-ctrl [subcommand]` to send the activation command to NDN-DPDK.
 
 ## Available Samples
 
 [Forwarder](../docs/forwarder.md): activate with `fw-args.ts`
 
 ```bash
-corepack pnpm start -s fw-args.ts | ndndpdk-ctrl activate-forwarder
+corepack pnpm -s start fw-args.ts | ndndpdk-ctrl activate-forwarder
 ```
 
 [Traffic generator](../docs/trafficgen.md): activate with `gen-args.ts`, use traffic pattern in `gen-config.ts`
 
 ```bash
-corepack pnpm start -s gen-args.ts | ndndpdk-ctrl activate-trafficgen
-corepack pnpm start -s gen-config.ts | ndndpdk-ctrl start-trafficgen
+corepack pnpm -s start gen-args.ts | ndndpdk-ctrl activate-trafficgen
+corepack pnpm -s start gen-config.ts | ndndpdk-ctrl start-trafficgen
 ```
 
 [File server](../docs/fileserver.md): activate with `fileserver-args.ts`
 
 ```bash
-corepack pnpm start -s fileserver-args.ts | ndndpdk-ctrl activate-fileserver
+corepack pnpm -s start fileserver-args.ts | ndndpdk-ctrl activate-fileserver
 ```

sample/activate/fileserver-args.ts

@@ -24,6 +24,7 @@ const args: ActivateFileServerArgs = {
     mounts: [
       { prefix: "/fileserver/usr-local-bin", path: "/usr/local/bin" },
       { prefix: "/fileserver/usr-local-lib", path: "/usr/local/lib" },
+      { prefix: "/fileserver/usr-local-share", path: "/usr/local/share" },
     ],
     segmentLen: 6 * 1024,
     uringCapacity: 4096,