Skip to content

Latest commit

 

History

History
65 lines (41 loc) · 2.24 KB

README.md

File metadata and controls

65 lines (41 loc) · 2.24 KB

Continuous Integration Go Report Card Code Climate

caretakerd

caretakerd is a simple process supervisor. There are no external dependencies and it is optimized for containerization (like Docker) and simple configuration.

Documentation

For general documentation, please refer to caretakerd.echocat.org.

For specific versions, please refer to caretakerd.echocat.org/all/.

Building

Requirements

To build caretakerd, you only need:

  • a compatible operating system (Linux, Windows or Mac OS X)
  • a working Go (at least version 1.11)

The build system will download every dependency and build it if necessary.

Run

To run caretakerd, invoke the following:

# Run all tests
go run ./build test

# Build binaries
go run ./build build

Build artifacts

  • You can find the compiled and linked binaries under ./var/binaries/
  • You can find the generated document under ./var/manuals/
  • You can find the packaged TARZs and ZIPs under ./var/dist/

Contributing

caretakerd is an open source project by echocat. So if you want to make this project even better, you can contribute to this project on GitHub by fork us.

If you commit code to this project, you have to accept that this code will be released under the license of this project.

Support

If you need support you can create a ticket in our issue tracker or join our chat at echocat.slack.com/messages/caretakerd.

License

See the LICENSE file.