/dockure

Simplifying the containerization process

Primary LanguageJavaScript

Contributors Forks Stargazers Issues


Logo

Simplifying the containerization process outside of the command line.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgements

About The Project

Built With

Getting Started

Starting our app is super easy! Just make sure you have Yarn and Docker if you don't already.

Prerequisites

In order for the application to work:

  1. Must have Docker Desktop or Docker Daemon running in the background.
  2. Must install yarn:
npm install yarn
  • For security purposes, please make sure you use this app in your local network unless you provide your own TCP TLS/SSH security. Pre-packaged SSH capabilities are currently in beta!

Installation

The pre-bundled app will be coming in Dockure 2.0, but for now:

  1. Clone the repo
  2. install dependencies 
    yarn install
  3. create an .env file in the root directory filling in your personal DB_host and JWT secret like below:
# Database
DB_HOST=your.db.here
# Bcrypt
BCRYPT_SALT_ROUNDS=10
# JWT
JWT_SECRET=your.secret.here
JWT_EXPIRES_SEC=86400

|-- .github (folder)
|-- client (folder)
|-- electron (folder)
|-- server (folder)

|-- .env (file) <----- right here!
|-- index.html
|-- etcetra...
  1. build the app 
    yarn build
  2. start it 
    yarn start
  • After logging in for the first time, it may take some time for dependencies to load.

signin

Alternatively, you can skip steps 4-5 and run this application in dev mode outside of electron:

 yarn dev

Usage

Once you are logged in there are loads you can do. Here are some examples:

  • Our simple homepage displays containers and their data. You can view container data and/or select multiple containers you'd like to start and stop containers

  • In our images tab, you can run your images to build containers. You can also pull locally or on Docker Hub and build images. imagestab

build

  • In our YAML/Dockerfile editor tab, we provide a simple Dockerfile or YAML editor for you to create, edit and save your own files without opening up an IDE. yaml

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Acknowledgements