Skip to content

Commit

Permalink
init docker build script
Browse files Browse the repository at this point in the history
  • Loading branch information
jmarmstrong1207 committed Sep 29, 2024
1 parent 3a11250 commit ddf5232
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 6 deletions.
23 changes: 17 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,14 @@

## _Quick Access_

- [Features](https://github.com/crocodilestick/Calibre-Web-Automated?tab=readme-ov-file#what-does-it-do-) 🪄
- [Features](#what-does-it-do-) 🪄
- [Releases](https://github.com/crocodilestick/Calibre-Web-Automated/releases) 🆕
- [Roadmap](https://github.com/crocodilestick/Calibre-Web-Automated?tab=readme-ov-file#under-active-development-%EF%B8%8F) 🛣️
- [How to Install](https://github.com/crocodilestick/Calibre-Web-Automated?tab=readme-ov-file#how-to-install-): 📖
- [Docker-Compose](https://github.com/crocodilestick/Calibre-Web-Automated?tab=readme-ov-file#method-1-using-docker-compose--recommended) 🐋⭐(Recommended)
- [Quick Install](https://github.com/crocodilestick/Calibre-Web-Automated/tree/main?tab=readme-ov-file#quick-install-) 🚀
- [Usage](https://github.com/crocodilestick/Calibre-Web-Automated?tab=readme-ov-file#method-2-using-the-script-install-method-with-clean-calibre-web-base-image--not-recommended) 🔧
- [Roadmap](#under-active-development-%EF%B8%8F) 🛣️
- [How to Install](#how-to-install-): 📖
- [Quick Install](#quick-install-) 🚀
- [Docker-Compose](#using-docker-compose-recommended) 🐋⭐(Recommended)
- [For Developers](#for-developers) 🚀
- [Usage](#usage-)
- [Further Development](https://github.com/crocodilestick/Calibre-Web-Automated?tab=readme-ov-file#method-2-using-the-script-install-method-with-clean-calibre-web-base-image--not-recommended) 🏗️
- [Support / Buy me a Coffee](https://ko-fi.com/crocodilestick)

Expand Down Expand Up @@ -194,6 +195,16 @@ services:

### And just like that, Calibre-Web Automated should be up and running!

---
## For Developers
If you want to contribute to this project, you can build a docker file by running `build.sh` in the repository.
This will build the docker image of the cloned repository with the modifications you have made>

```
$ chmod +x build.sh
$ ./build.sh
```

<!-- - By default, `/cwa-book-ingest` is the ingest folder bound to the ingest folder you entered in the Docker Compose template however should you want to change any of the default directories, use the `cwa-change-dirs` command from within the container to edit the default paths -->

### 2. **_Recommended Post-Install Tasks:_**
Expand Down
7 changes: 7 additions & 0 deletions build.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
#!/bin/sh

docker build --tag crocodilestick/calibre-web-automated:master
# optional: --build-arg="BUILD_DATE=27-09-2024 12:06" --build-arg="VERSION=2.1.0-test-5" .

mkdir -p build

0 comments on commit ddf5232

Please sign in to comment.