Skip to content

Latest commit

 

History

History
76 lines (51 loc) · 2.6 KB

README.md

File metadata and controls

76 lines (51 loc) · 2.6 KB
Raw

SimplyCode Docker

SimplyEdit Project stage: Development License standard-readme compliant

Docker environment to create SimplyCode applications in.

Install

To use the docker image, pull it from the GitHub Container Registry (ghcr.io).

A latest version is not tagged for various reasons. To use the latest version, use the main tag:

docker pull ghcr.io/simplyedit/simplycode-docker:main

Versioned images are also available:

docker pull ghcr.io/simplyedit/simplycode-docker:v0.5.0

Usage

For most use cases, the following command should be enough:

docker run \
    --env "USER_GID=$(id -g)" \
    --env "USER_ID=$(id -u)" \
    --interactive \
    --rm \
    --tty \
    --volume "${PWD}:/var/www/www/api/data" \
    ghcr.io/simplyedit/simplycode-docker:main

This will mount the current working directory into the docker image at the right place, and start the SimplyCode server.

When using Docker Desktop, it is advised to use the --publish-all flag to make the SimplyCode server available on the host machine.

That way, the SimplyCode server can be accessed by using the "Open in Browser" button in Docker Desktop.

screenshot of "open in browser" button

Contribute

Feedback and contributions are welcome. Please open an issue or pull request.

Development

This repository should not have any significant code.

Currently, the only code is:

  • Dockerfile that builds a docker image with SimplyCode installed
  • entrypoint.sh that is used to run SimplyCode in the Docker image (and do some checks)
  • .github/workflows/publish.yml GitHub workflow that builds and publishes the docker image

License

Created by SimplyEdit under an MIT License.