{"id":15645100,"url":"https://github.com/pascalgrimaud/generator-jhipster-docker","last_synced_at":"2025-10-06T02:10:35.546Z","repository":{"id":48020644,"uuid":"47505774","full_name":"pascalgrimaud/generator-jhipster-docker","owner":"pascalgrimaud","description":":whale: JHipster module, additional Docker support in your JHipster application","archived":false,"fork":false,"pushed_at":"2022-12-06T19:48:19.000Z","size":653,"stargazers_count":57,"open_issues_count":11,"forks_count":7,"subscribers_count":8,"default_branch":"master","last_synced_at":"2024-03-15T09:08:39.379Z","etag":null,"topics":["docker","docker-compose","jhipster","jhipster-module"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pascalgrimaud.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-12-06T17:10:21.000Z","updated_at":"2022-12-01T17:35:13.000Z","dependencies_parsed_at":"2023-01-23T15:00:07.965Z","dependency_job_id":null,"html_url":"https://github.com/pascalgrimaud/generator-jhipster-docker","commit_stats":null,"previous_names":[],"tags_count":23,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pascalgrimaud%2Fgenerator-jhipster-docker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pascalgrimaud%2Fgenerator-jhipster-docker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pascalgrimaud%2Fgenerator-jhipster-docker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pascalgrimaud%2Fgenerator-jhipster-docker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pascalgrimaud","download_url":"https://codeload.github.com/pascalgrimaud/generator-jhipster-docker/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248804719,"owners_count":21164127,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docker","docker-compose","jhipster","jhipster-module"],"created_at":"2024-10-03T12:04:31.293Z","updated_at":"2025-10-06T02:10:30.529Z","avatar_url":"https://github.com/pascalgrimaud.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# generator-jhipster-docker\n[![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency Status][daviddm-image]][daviddm-url]\n\n\u003e JHipster module, additional Docker support in your JHipster application\n\n\u003cdiv align=\"center\"\u003e\n  \u003ca href=\"http://www.jhipster.tech/\"\u003e\n    \u003cimg src=\"https://github.com/pascalgrimaud/generator-jhipster-docker/raw/master/images/logo-jhipster.png\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://www.docker.com/\"\u003e\n    \u003cimg width=200px src=\"https://github.com/pascalgrimaud/generator-jhipster-docker/raw/master/images/logo-docker.png\"\u003e\n  \u003c/a\u003e\n\u003c/div\u003e\n\n\n# Introduction\n\nThis is a [JHipster](http://www.jhipster.tech/) module, that is meant to be used in a JHipster application. This module is used to generate a:\n\n- Dockerfile for Automated build at [Docker Hub](https://hub.docker.com/)\n- Docker Compose file for using a Local SMTP Server with [MailDev](https://github.com/djfarrelly/MailDev/)\n- Docker Compose file for using NGinx as proxy server\n\n\n# Table of contents\n\n\u003c!-- START doctoc generated TOC please keep comment here to allow auto update --\u003e\n\u003c!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --\u003e\n- [Prerequisites](#prerequisites)\n- [Installation](#installation)\n  - [With Yarn](#with-yarn)\n  - [With NPM](#with-npm)\n- [Usage](#usage)\n  - [1 - Automated build at the Docker Hub](#1---automated-build-at-the-docker-hub)\n    - [1.1 - Description](#11---description)\n    - [1.2 - Generate the files](#12---generate-the-files)\n    - [1.3 - Set your Docker Hub project](#13---set-your-docker-hub-project)\n      - [At GitHub](#at-github)\n      - [At Docker Hub](#at-docker-hub)\n  - [2 - Local SMTP Server](#2---local-smtp-server)\n  - [3 - NGinx as proxy server](#3---nginx-as-proxy-server)\n- [License](#license)\n\n\u003c!-- END doctoc generated TOC please keep comment here to allow auto update --\u003e\n\n\n# Prerequisites\n\nAs this is a [JHipster](http://www.jhipster.tech/) module, we expect you have JHipster and its related tools already installed:\n\n- [Installing JHipster](http://www.jhipster.tech/installation/)\n\nYou have to install Docker and Docker Compose:\n\n- [Docker](https://docs.docker.com/installation/#installation)\n- [Docker Compose](https://docs.docker.com/compose/install)\n\nTo use *Automated build*, you have to create an account at:\n\n- [https://hub.docker.com/](https://hub.docker.com/)\n\n\n# Installation\n\n## With Yarn\n\nTo install this module:\n\n```bash\nyarn global add generator-jhipster-docker\n```\n\nTo update this module:\n\n```bash\nyarn global upgrade generator-jhipster-docker\n```\n\n## With NPM\n\nTo install this module:\n\n```bash\nnpm install -g generator-jhipster-docker\n```\n\nTo update this module:\n\n```bash\nnpm update -g generator-jhipster-docker\n```\n\n# Usage\n\nTo run the module on a JHipster generated application:\n\n```bash\nyo jhipster-docker\n```\n\nYou can use this command to generate the Dockerfile for Automated build:\n\n```bash\nyo jhipster-docker default\n```\n\nTo force the generator:\n\n```bash\nyo jhipster-docker default --force\n```\n\n\n\n## 1 - Automated build at the [Docker Hub](https://hub.docker.com)\n\n### 1.1 - Description\n\nWhen using the option *Dockerfile for Automated build*, [Docker Hub](https://hub.docker.com) will build a Docker image everytime you commit to your repository.\n\n### 1.2 - Generate the files\n\n- Launch : `yo jhipster-docker`\n- Select the option : `Dockerfile for Automated build at https://hub.docker.com/`\n\n### 1.3 - Set your Docker Hub project\n\n#### At GitHub\n\n- Go to Settings \u003e Integrations \u0026 services\n- Add service and select Docker\n- Click [x] active\n- Click on update service\n- Back to Integration \u0026 services, Docker must be :white_check_mark: Docker\n\n\n#### At Docker Hub\n\n- Go to [https://hub.docker.com/r/YOUR_DOCKER_ID/](https://hub.docker.com/r/YOUR_DOCKER_ID/) (replace `YOUR_DOCKER_ID` by yours)\n- Menu Create\n    - Select Create Automated Build\n    - Select the repository of your project\n    - Put a description, then click on create\n\u003cdiv align=\"center\"\u003e\n  \u003ca href=\"http://www.jhipster.tech/\"\u003e\n    \u003cimg src=\"https://github.com/pascalgrimaud/generator-jhipster-docker/raw/master/images/automated-step1.png\"\u003e\n  \u003c/a\u003e\n  \u003cbr/\u003e\n  \u003ca href=\"https://www.docker.com/\"\u003e\n    \u003cimg src=\"https://github.com/pascalgrimaud/generator-jhipster-docker/raw/master/images/automated-step2.png\"\u003e\n  \u003c/a\u003e\n\u003c/div\u003e\n\n\n- Go to Build Settings\n    - Choose your branch or let master by default\n    - Put this Dockerfile location: /\n    - Click on Save Changes\n\u003cdiv align=\"center\"\u003e\n  \u003ca href=\"https://www.docker.com/\"\u003e\n    \u003cimg src=\"https://github.com/pascalgrimaud/generator-jhipster-docker/raw/master/images/automated-step3.png\"\u003e\n  \u003c/a\u003e\n\u003c/div\u003e\n\n\n- Return to this project: git commit and push these changes!\n- Go to Build details: it should be a new line with Building\n\n\n## 2 - Local SMTP Server\n\nThe project [djfarrelly/maildev](https://github.com/djfarrelly/MailDev) is a simple way to test your project’s generated emails during development with an easy to use web interface.\n\nYou can launch:\n\n```bash\ndocker-compose -f src/main/docker/smtp.yml up -d\n```\n\nYou can access to it: [http://localhost:1080](http://localhost:1080)\n\n\n## 3 - NGinx as proxy server\n\nSee the official [documentation](http://www.jhipster.tech/separating-front-end-and-api/)\n\nFollow these steps:\n- Start your local backend server or use an existing one. You can start more than 1 backend server.\n- Edit `src/main/docker/nginx/nginx.conf`, depending on the 1st step\n- Start NGinx:\n\n```bash\ndocker-compose -f src/main/docker/nginx.yml up -d\n```\n\n**Note**:\nThe use of `network_mode: 'host'` in `nginx.yml` may not work for Windows or MacOS.\nSimply comment it and replace `localhost` in `src/main/docker/nginx/nginx.conf` file.\nYour container (from inside) must access to the application.\n\nYou can access to it: [http://localhost](http://localhost) or [http://localhost:8000](http://localhost/8000)\n\n\n# License\n\nApache-2.0 © [Pascal Grimaud](https://twitter.com/pascalgrimaud) and the respective JHipster contributors\n\n[npm-image]: https://img.shields.io/npm/v/generator-jhipster-docker.svg\n[npm-url]: https://npmjs.org/package/generator-jhipster-docker\n[travis-image]: https://travis-ci.org/pascalgrimaud/generator-jhipster-docker.svg?branch=master\n[travis-url]: https://travis-ci.org/pascalgrimaud/generator-jhipster-docker\n[daviddm-image]: https://david-dm.org/pascalgrimaud/generator-jhipster-docker.svg?theme=shields.io\n[daviddm-url]: https://david-dm.org/pascalgrimaud/generator-jhipster-docker\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpascalgrimaud%2Fgenerator-jhipster-docker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpascalgrimaud%2Fgenerator-jhipster-docker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpascalgrimaud%2Fgenerator-jhipster-docker/lists"}