Skip to content
Reflex Reflex Reflex Docs

Quick start

This page takes you from download to a scheduled script on your own machine.

You need Docker, or Java for the standalone jars (./run.sh true downloads a JRE for you). Reflex releases are private: get an account from BQA (access). On Reflex hosted by BQA, sign in to your server and start at step 3.

  1. Download and start Reflex.

    Download reflex.zip from the releases page, unpack it and start the server and an agent:

    Terminal window
    chmod +x run.sh && ./run.sh

  2. Sign in.

    Open http://localhost:7000 and sign in as admin with password admin.

  3. Create a project and add the agent.

    Create a project with New project. Open Agents, choose Add agent, then URL and key:

    • URL: http://localhost:7001. With Docker Compose use http://agent:7001. The server must be able to reach this address.
    • Key: dev.

    The agent should show as online. To run an agent on another machine without opening a port, use a pair code instead: see Agents.

  4. Write and run a script.

    Save this as hello.lua in the project: commit it to the project’s git repository, or put it in the project folder on the server (projects/<user>/<project>/). Open Code, select the file and press Run:

    local response = Rest.get("https://httpbin.org/json")
    print("status", response.status)
    print("title", Json.decode(response.body).slideshow.title)

    Steps and output stream in live. If a run fails, see Debugging.

  5. Schedule it.

    Open Jobs, choose New job, pick hello.lua and enter a cron expression. 0 */15 * ? * * runs every 15 minutes. Check the result under Runs.

Next

Section titled “Next”