-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
147 additions
and
90 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,34 +1,70 @@ | ||
| # Java project type gitignore | ||
| ### Git ### | ||
| !.gitkeep | ||
|
|
||
| # Compiled class file | ||
| *.class | ||
|
|
||
| # Log file | ||
| *.log | ||
| ### STS ### | ||
| .apt_generated | ||
| .classpath | ||
| .factorypath | ||
| .project | ||
| .settings | ||
| .springBeans | ||
| .sts4-cache | ||
|
|
||
| # BlueJ files | ||
| *.ctxt | ||
|
|
||
| # Mobile Tools for Java (J2ME) | ||
| .mtj.tmp/ | ||
| ### IntelliJ IDEA ### | ||
| .idea | ||
| *.iws | ||
| *.iml | ||
| *.ipr | ||
|
|
||
| # Package Files # | ||
| *.jar | ||
| *.war | ||
| *.nar | ||
| *.ear | ||
| *.zip | ||
| *.tar.gz | ||
| *.rar | ||
|
|
||
| # virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml | ||
| hs_err_pid* | ||
| replay_pid* | ||
| ### NetBeans ### | ||
| /nbproject/private/ | ||
| /nbbuild/ | ||
| /dist/ | ||
| /nbdist/ | ||
|
|
||
| # Docker gitignore | ||
| /.nb-gradle/ | ||
|
|
||
|
|
||
| ### VS Code ### | ||
| .vscode/ | ||
|
|
||
| dump.rdb | ||
|
|
||
| # Application specific gitignore | ||
| # Maven | ||
| target/ | ||
|
|
||
| ### OS Specific ### | ||
| .DS_Store | ||
| .tmp/ | ||
|
|
||
| tmp/ | ||
|
|
||
|
|
||
| ### Maven ### | ||
| logs/ | ||
| target/ | ||
|
|
||
| .classpth | ||
| .mvn/timing.properties | ||
| .mvn/wrapper/maven-wrapper.jar | ||
| .project | ||
|
|
||
| buildNumber.properties | ||
| dependency-reduced-pom.xml | ||
| pom.xml.next | ||
| pom.xml.tag | ||
| pom.xml.releaseBackup | ||
| pom.xml.versionsBackup | ||
| release.properties | ||
|
|
||
|
|
||
| ### Weaver ### | ||
| dist/ | ||
|
|
||
|
|
||
| ### Project Specific ### | ||
| .env* | ||
|
|
||
| !**/src/main/** | ||
| !**/src/test/** |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,53 +1,67 @@ | ||
| <a name="readme-top"></a> | ||
| # Deployment Guide | ||
|
|
||
| ## Production Deployments | ||
|
|
||
| For **production** deployments, deploy using `docker-compose` via the [MyLibrary App][app-repo]. | ||
| This is the recommended method of deployment for production systems. | ||
| Go to the [MyLibrary App][app-repo] and following the deployment instructions there. | ||
|
|
||
| Performing the deployment using the [MyLibrary App][app-repo] should be something similar to the following: | ||
| ```shell | ||
| docker-compose up | ||
| ``` | ||
|
|
||
| The **development** deployment can also use `docker-compose` in the same way. | ||
|
|
||
| <div align="right">(<a href="#readme-top">back to top</a>)</div> | ||
|
|
||
|
|
||
| ## Development Deployment using **Docker** | ||
|
|
||
| To manually use `docker` rather than `docker-compose`, run the following: | ||
|
|
||
| ```shell | ||
| docker image build -t service . | ||
| docker run -it service | ||
| ``` | ||
|
|
||
| ``` | ||
| docker build --help | ||
| # -t, --tag list Name and optionally a tag in the | ||
| ``` | ||
|
|
||
| ``` | ||
| docker run --help | ||
| # -i, --interactive Keep STDIN open even if not attached. | ||
| # -t, --tty Allocate a pseudo-TTY | ||
| ``` | ||
|
|
||
| <div align="right">(<a href="#readme-top">back to top</a>)</div> | ||
|
|
||
| ## Development Deployment using **Maven** | ||
|
|
||
| Running locally is easiest using spring boot: | ||
|
|
||
| ```shell | ||
| mvn spring-boot:run | ||
| ``` | ||
|
|
||
| <div align="right">(<a href="#readme-top">back to top</a>)</div> | ||
|
|
||
| <!-- LINKS --> | ||
| [app-repo]: https://github.com/TAMULib/MyLibrary | ||
| <a name="readme-top"></a> | ||
| # Project Management Service Deployment Guide | ||
|
|
||
| ## Production Deployments | ||
|
|
||
| For **production** deployments, deploy using `docker-compose` via the [Project App Repo][app-repo]. | ||
| This is the recommended method of deployment for production systems. | ||
| Go to the [Project Management App Repo][app-repo] and following the deployment instructions there. | ||
|
|
||
| Performing the deployment using the [Project Management App Repo][app-repo] should be something similar to the following: | ||
| ```shell | ||
| docker-compose up | ||
| ``` | ||
|
|
||
| The **development** deployment can also use `docker-compose` in the same way. | ||
|
|
||
| <div align="right">(<a href="#readme-top">back to top</a>)</div> | ||
|
|
||
|
|
||
| ## Development Deployment using Docker | ||
|
|
||
| To manually use `docker` rather than `docker-compose`, run the following: | ||
|
|
||
| ```shell | ||
| docker image build -t projectservice . | ||
| docker run -it projectservice | ||
| ``` | ||
|
|
||
| <sub>_* Note: `-t projectservice` and `-it projectservice` may be changed to another tag name as desired, such as `-t developing_on_this` and `-it developing_on_this`._</sub><br> | ||
|
|
||
| <div align="right">(<a href="#readme-top">back to top</a>)</div> | ||
|
|
||
|
|
||
| ## Development Deployment using Maven | ||
|
|
||
| Manual deployment can be summed up by running: | ||
|
|
||
| ```shell | ||
| mvn spring-boot:run | ||
| ``` | ||
|
|
||
| Those steps are a great way to start but they also fail to explain the customization that is often needed. | ||
| There are multiple ways to further configure this for deployment to better meet the desired requirements. | ||
|
|
||
| It is highly recommended only to perform *manual installation* when developing. | ||
| For **production** deployment, please use `docker-compose` via the [Project Management App Repo][app-repo] or use the **Docker** method above. | ||
|
|
||
| <div align="right">(<a href="#readme-top">back to top</a>)</div> | ||
|
|
||
|
|
||
| ### Directly Configuring the `src/main/resources/application.yml` File | ||
|
|
||
| This method of configuration works by altering the configuration file. | ||
|
|
||
| With this in mind, the deployment steps now look like: | ||
|
|
||
| ```shell | ||
| # Edit 'src/main/resources/application.yml' here. | ||
|
|
||
| mvn spring-boot:run | ||
| ``` | ||
|
|
||
| <div align="right">(<a href="#readme-top">back to top</a>)</div> | ||
|
|
||
|
|
||
| <!-- LINKS --> | ||
| [app-repo]: https://github.com/TAMULib/ProjectManagement |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters