mgallina/smockin repository overview

⁠sMockin

v 2.20.1

⁠INTRODUCTION

sMockin is a mock server and visual tool, used to dynamically mock API endpoints, S3 buckets & Email Accounts.

Unlike other mocking frameworks, sMockin allows users to create mocks through a rich UI experience rather than relying on code or scripting skills.

In addition to this, mocks can also be delivered dynamically, enabling your mocked API service to mimic real world use cases.

For more details please visit https://www.smockin.com⁠.

Source project: https://github.com/mgtechsoftware/smockin⁠.

⁠INSTALLATION

To start up a container:

docker run --name smockin -d -p 8000:8000 -p 8001:8001 -p 8002:8002 -p 8003:8003 mgallina/smockin:2201

Once running (allow 20-30 secs startup), the sMockin dashboard can be accessed from here: http://localhost:8000/index.html⁠

(Please note this 'dockerised' version of sMockin comes with 'multi user' disabled by default.)

⁠SAVING DATA

sMockin uses an internal DB to save data. This data should remain persisted by default within your local container every time it is stopped and started:

docker stop smockin
docker start smockin

⁠DOCUMENTATION

Help and details on how to get started with sMockin can all be found at the following 2 locations:

• GitHub Wiki page: https://github.com/mgtechsoftware/smockin/wiki⁠
• sMockin Cloud website: https://www.smockin.com/help⁠

⁠REDISTRIBUTING

Quite often it is useful to populate a base image of sMockin with any mocked endpoints you need for a particular application and then redistribute this version of the image alongside your project.

The easiest way of saving a sMockin image with saved state, is to simply perform a commit and then push the saved image to a registry such as Docker Hub:

docker commit -m='your comments' smockin smockin-myproject
docker push

Alternatively, you can save your image locally to an archive file like so:

docker save smockin-myproject > /some/path/smockin-myproject.tar

The file can then be imported into another Docker daemon:

docker load < /some/path/smockin-myproject.tar

... and finally spun up:

docker run --name smockin -d -p 8000:8000 -p 8001:8001 -p 8002:8002 -p 8003:8003 -t smockin-myproject

⁠AMENDING CONFIG WITHIN THE CONTAINER

To enable multi user mode (or make changes to any other configuration settings in sMockin)

Ensure your sMockin container is running:

docker start smockin

Once started, run the following to access the container's command line:

docker exec -it smockin sh

Install an editor such as vim:

apk -U add vim

Once installed, open the launch script with vim:

vi launch.sh

Look for the config setting 'MULTI_USER_MODE' and set this to 'TRUE' like so:

MULTI_USER_MODE=TRUE

Save your changes and exit for the file

If you are new to vim:

- Click the ESC key on your keyboard 
- This should open a prompt in the bottom left hand corner, prefixed with a semi colon
- Enter the the characters 'wq' (You should see ':wq' in the bottom left hand corner prompt)
- Finally hit the ENTER key to save and exit the file.

From the container command line type 'exit' to exit the container:

exit

Finally run the following to put the changes into effect:

docker restart smockin

To login from the sMockin dashboard, please use the default 'system admin' credentials:

username: admin
password: admin

To ensure these changes are preserved across any newly provisioned containers in the future, you may wish to save this to your own separate base image (see REDISTRIBUTING above).

Please visit www.smockin.com⁠ for more information.