Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »


    Sandbox Asset Server

    A simple set of CRUD services to manage Sandbox assets, plus basic permissions and metadata management. See the API documentation for details.

    Running As A Standalone Server

    Clone the git repository and install its dependencies:

    ~ $ git clone
    ~ $ cd SandboxAssetServer
    ~/SandboxAssetServer $ npm install

    Configure the new server:

    ~/SandboxAssetServer $ cp config.sample.json config.json
    ~/SandboxAssetServer $ nano config.json

    Run the server:

    ~/SandboxAssetServer $ node src/app.js

    Running As A Node Module

    Install the server as a dependency:

    $ npm install --save adlnet/SandboxAssetServer.git#v1.0.0

    Add it to your Express app:

    var SAS = require('SandboxAssetServer');
    app.use('/my/basepath', SAS({
        'dataDir': libpath.resolve(__datadir, 'asset_data'),
        'sessionCookieName': 'session',
        'sessionHeader': 'X-Session-Cookie',
        'sessionSecret': 'unsecure cookie secret'

    Configuration Options

    • dataDir - The directory where all assets will be stored, relative to the project root. Recommend using an absolute path for module includes.
    • sessionCookieName - The name of the cookie to contain the encrypted client session. Used for decryption, even if passed in the headers.
    • sessionHeader - The name of the header to contain the encrypted client session in case cookies are not viable.
    • sessionSecret - The encryption key for the client session.
    • port - STANDALONE ONLY. The port for the server to listen on.
    • urlBasePath - STANDALONE ONLY. Set as prefix to all API endpoints. E.g. setting this value to /adl/sandbox/ will yield the API endpoint /adl/sandbox/assets/new.


    npm i sandbox-asset-server

    Downloadslast 7 days







    last publish


    • avatar