Giter Club home page Giter Club logo

shentrypoint's Introduction

Shentrypoint

Shentrypoint is a script that provides an easy way to debug your Docker applications without getting in your way. Shentrypoint does run as PID 1, but it doesn't aim to be a full init process.

Guiding Principles

  1. When your container starts, your application should start
  2. When your application dies, your container should die
  3. When you send control signals to your container, your application process should receive them
  4. When you send SIGINT (CTRL+C) to your container, you should get a shell prompt (not a stopped container) as if you'd been running your application process in the foreground from a shell all along

Why?

We put together a lot of automation around running containers in terms of configuration for inputs, network, volumes, etc, not to mention connecting these containers to other systems in a deployment. Sometimes, the easiest way to get a debugging environment is to take over an existing container. Shentrypoint makes it possible to docker attach to an existing container and you can pretend you had launched the application as a foreground process all along. You can hit CTRL+C, modify your container's filesystem, run arbitrary commands, restart your application and debug it interactively.

How to Use It

  1. Create a Procfile where the keys are the command words you want to run later
  2. Add shentrypoint to your docker image
  3. Add ENTRYPOINT /path/to/shentrypoint to your Dockerfile

Use the command words defined in your Procfile to run your containers

shentrypoint's People

Contributors

stevecrozz avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.