.. _quickstart_sandbox:

Sandbox
=======
The VoIPBin Sandbox lets you run the entire VoIPBin platform on your local machine with a single command. No sign-up required — it comes with a pre-configured admin account and is ready to use immediately.

Prerequisites
-------------
- Docker and Docker Compose v2

Install and Run
---------------
Clone the sandbox repository and launch the interactive CLI:

.. code::

    $ git clone https://github.com/voipbin/sandbox.git
    $ cd sandbox
    $ sudo ./voipbin

Initialize and start the services:

.. code::

    voipbin> init
    voipbin> start

Once started, you can log in with the default admin account:

- **Username**: admin@localhost
- **Password**: admin@localhost

For full documentation, troubleshooting, and advanced usage, see the `Sandbox GitHub repository <https://github.com/voipbin/sandbox>`_.

Using Tutorials with the Sandbox
--------------------------------
All tutorials in this documentation use ``https://api.voipbin.net`` as the API endpoint. If you are using the sandbox, substitute it with your local sandbox endpoint:

- **Production**: ``https://api.voipbin.net``
- **Sandbox**: ``https://api.voipbin.test:8443``

For example, to generate a token using the sandbox:

.. code::

    $ curl --request POST 'https://api.voipbin.test:8443/auth/login' \
        --header 'Content-Type: application/json' \
        --data-raw '{
            "username": "admin@localhost",
            "password": "admin@localhost"
        }'