Fix healthcheck

Fazzani · Dec 27, 2024 · 5ebd6f6 · 5ebd6f6
1 parent 2c6a66a
commit 5ebd6f6
Show file tree

Hide file tree

Showing 9 changed files with 257 additions and 190 deletions.
diff --git a/Dockerfile b/Dockerfile
@@ -1,8 +1,10 @@
 FROM mcr.microsoft.com/dotnet/aspnet:9.0 AS base
 USER $APP_UID
 WORKDIR /app
-EXPOSE 8880
-EXPOSE 8881
+
+ENV ASPNETCORE_HTTP_PORTS=8880
+
+EXPOSE $ASPNETCORE_HTTP_PORTS
 
 ENV LOG_FOLDER=/logs
 ENV LOG_LEVEL=Information
@@ -26,11 +28,20 @@ RUN dotnet publish "./Proxarr.Api.csproj" -c $BUILD_CONFIGURATION -o /app/publis
 
 # This stage is used in production or when running from VS in regular mode (Default when not using the Debug configuration)
 FROM base AS final
+
 WORKDIR /app
 VOLUME ${LOG_FOLDER}/
 VOLUME ${CONFIG_PATH}/
 COPY --from=publish /app/publish .
 
-HEALTHCHECK --interval=10s --timeout=3s CMD curl -f http://localhost:8880/health || exit 1
+USER root
+
+RUN apt-get update && apt-get install -y --no-install-recommends \
+  curl \
+  && rm -rf /var/lib/apt/lists/*
+
+USER $APP_UID
+
+HEALTHCHECK --interval=30s --timeout=10s --start-period=5s --retries=3 CMD curl -f http://localhost:$ASPNETCORE_HTTP_PORTS/health || exit 1
 
 ENTRYPOINT ["dotnet", "Proxarr.Api.dll"]
diff --git a/README.md b/README.md
@@ -1,179 +1,178 @@
-<a id="readme-top"></a>
-[![Contributors][contributors-shield]][contributors-url]
-[![Forks][forks-shield]][forks-url]
-[![Stargazers][stars-shield]][stars-url]
-[![Issues][issues-shield]][issues-url]
-[![project_license][license-shield]][license-url]
-[![LinkedIn][linkedin-shield]][linkedin-url]
-
-[![Docker Image CI](https://github.com/Fazzani/Proxarr/actions/workflows/docker-image.yml/badge.svg)](https://github.com/Fazzani/Proxarr/actions/workflows/docker-image.yml)
-
-<!-- PROJECT LOGO -->
-<br />
-<div align="center">
-  <a href="https://github.com/Fazzani/Proxarr">
-    <img src="images/logo.png" alt="Logo" width="320" height="320">
-  </a>
-
-  <p align="center">
-    Simple proxy server that can be used to auto qualify requested item media based on their availability on countries watching providers.
-    <br />
-    <a href="https://github.com/Fazzani/Proxarr"><strong>Explore the docs »</strong></a>
-    <br />
-    <br />
-    <a href="https://github.com/Fazzani/Proxarr">View Demo</a>
-    ·
-    <a href="https://github.com/Fazzani/Proxarr/issues/new?labels=bug&template=bug-report---.md">Report Bug</a>
-    ·
-    <a href="https://github.com/Fazzani/Proxarr/issues/new?labels=enhancement&template=feature-request---.md">Request Feature</a>
-  </p>
-</div>
-
-<!-- TABLE OF CONTENTS -->
-<details>
-  <summary>Table of Contents</summary>
-  <ol>
-    <li>
-      <a href="#about-the-project">About The Project</a>
-    </li>
-    <li>
-      <a href="#getting-started">Getting Started</a>
-      <ul>
-        <li><a href="#prerequisites">Prerequisites</a></li>
-        <li><a href="#installation">Installation</a></li>
-      </ul>
-    </li>
-    <li><a href="#usage">Usage</a></li>
-    <li><a href="#roadmap">Roadmap</a></li>
-    <li><a href="#contributing">Contributing</a></li>
-    <li><a href="#license">License</a></li>
-    <li><a href="#contact">Contact</a></li>
-  </ol>
-</details>
-
-<!-- ABOUT THE PROJECT -->
-## About The Project
-
-Proxarr is a simple proxy server that can be used to auto qualify if item media maybe downloaded or not, based on their availability on countries watching providers. 
-It is written in .NET (c#).
-
-<p align="right">(<a href="#readme-top">back to top</a>)</p>
-
-<!-- GETTING STARTED -->
-## Getting Started
-
-This is an example of how you may give instructions on setting up your project locally.
-To get a local copy up and running follow these simple example steps.
-
-### Prerequisites
-
-This is an example of how to list things you need to use the software and how to install them.
-* npm
-  ```sh
-  npm install npm@latest -g
-  ```
-
-### Installation
-
-1. Get a free API Key at [https://example.com](https://example.com)
-2. Clone the repo
-   ```sh
-   git clone https://github.com/Fazzani/Proxarr.git
-   ```
-3. Install NPM packages
-   ```sh
-   npm install
-   ```
-4. Enter your API in `config.js`
-   ```js
-   const API_KEY = 'ENTER YOUR API';
-   ```
-5. Change git remote url to avoid accidental pushes to base project
-   ```sh
-   git remote set-url origin Fazzani/Proxarr
-   git remote -v # confirm the changes
-   ```
-
-<p align="right">(<a href="#readme-top">back to top</a>)</p>
-
-<!-- USAGE EXAMPLES -->
-## Usage
-
-Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.
-
-```shell
-docker run -itd -e LOG_LEVEL=Debug -p 8880:8880 -v ${PWD}/config:/app/config --name proxarr synker/proxarr:latest
-```
-
-_For more examples, please refer to the [Documentation](https://example.com)_
-
-<p align="right">(<a href="#readme-top">back to top</a>)</p>
-
-<!-- ROADMAP -->
-## Roadmap
-
-- [ ] Improve Docker tagging with git tag
-- [ ] Remove secrets from code
-- [ ] Add more providers (JustWatch, Reelgood, etc)
-- [ ] Add docker-compose example
-- [ ] Add more tests
-- [ ] Add more documentation
-- [ ] CI/CD pipeline PR
-- [ ] Improve logging and error handling
-
-See the [open issues](https://github.com/Fazzani/Proxarr/issues) for a full list of proposed features (and known issues).
-
-<p align="right">(<a href="#readme-top">back to top</a>)</p>
-
-<!-- CONTRIBUTING -->
-## 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**.
-
-If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
-Don't forget to give the project a star! Thanks again!
-
-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
-
-<p align="right">(<a href="#readme-top">back to top</a>)</p>
-
-### Top contributors:
-
-<a href="https://github.com/Fazzani/Proxarr/graphs/contributors">
-  <img src="https://contrib.rocks/image?repo=Fazzani/Proxarr" alt="contrib.rocks image" />
-</a>
-
-<!-- LICENSE -->
-## License
-
-Distributed under the project_license. See `LICENSE.txt` for more information.
-
-<p align="right">(<a href="#readme-top">back to top</a>)</p>
-
-<!-- CONTACT -->
-## Contact
-
-Fazzani - [email protected]
-
-Project Link: [https://github.com/Fazzani/Proxarr](https://github.com/Fazzani/Proxarr)
-
-<p align="right">(<a href="#readme-top">back to top</a>)</p>
-
-<!-- MARKDOWN LINKS & IMAGES -->
-[contributors-shield]: https://img.shields.io/github/contributors/Fazzani/Proxarr.svg?style=for-the-badge
-[contributors-url]: https://github.com/Fazzani/Proxarr/graphs/contributors
-[forks-shield]: https://img.shields.io/github/forks/Fazzani/Proxarr.svg?style=for-the-badge
-[forks-url]: https://github.com/Fazzani/Proxarr/network/members
-[stars-shield]: https://img.shields.io/github/stars/Fazzani/Proxarr.svg?style=for-the-badge
-[stars-url]: https://github.com/Fazzani/Proxarr/stargazers
-[issues-shield]: https://img.shields.io/github/issues/Fazzani/Proxarr.svg?style=for-the-badge
-[issues-url]: https://github.com/Fazzani/Proxarr/issues
-[license-shield]: https://img.shields.io/github/license/Fazzani/Proxarr.svg?style=for-the-badge
-[license-url]: https://github.com/Fazzani/Proxarr/blob/master/LICENSE.txt
-[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
-[linkedin-url]: https://www.linkedin.com/in/heni-fazzani
-[product-screenshot]: images/screenshot.png
+<a id="readme-top"></a>
+[![Contributors][contributors-shield]][contributors-url]
+[![Forks][forks-shield]][forks-url]
+[![Stargazers][stars-shield]][stars-url]
+[![Issues][issues-shield]][issues-url]
+[![project_license][license-shield]][license-url]
+[![LinkedIn][linkedin-shield]][linkedin-url]
+
+[![Docker Image CI](https://github.com/Fazzani/Proxarr/actions/workflows/docker-image.yml/badge.svg)](https://github.com/Fazzani/Proxarr/actions/workflows/docker-image.yml)
+
+<!-- PROJECT LOGO -->
+<br />
+<div align="center">
+  <a href="https://github.com/Fazzani/Proxarr">
+    <img src="images/logo.png" alt="Logo" width="320" height="320">
+  </a>
+
+  <p align="center">
+    Automatically categorize your requested movies and TV shows from your watching providers.
+    <br />
+    <a href="https://github.com/Fazzani/Proxarr"><strong>Explore the docs »</strong></a>
+    <br />
+    <br />
+    <a href="https://github.com/Fazzani/Proxarr">View Demo</a>
+    ·
+    <a href="https://github.com/Fazzani/Proxarr/issues/new?labels=bug&template=bug-report---.md">Report Bug</a>
+    ·
+    <a href="https://github.com/Fazzani/Proxarr/issues/new?labels=enhancement&template=feature-request---.md">Request Feature</a>
+  </p>
+</div>
+
+<!-- TABLE OF CONTENTS -->
+<details>
+  <summary>Table of Contents</summary>
+  <ol>
+    <li>
+      <a href="#about-the-project">About The Project</a>
+    </li>
+    <li>
+      <a href="#getting-started">Getting Started</a>
+      <ul>
+        <li><a href="#prerequisites">Prerequisites</a></li>
+        <li><a href="#installation">Installation</a></li>
+      </ul>
+    </li>
+    <li><a href="#usage">Usage</a></li>
+    <li><a href="#roadmap">Roadmap</a></li>
+    <li><a href="#contributing">Contributing</a></li>
+    <li><a href="#license">License</a></li>
+    <li><a href="#contact">Contact</a></li>
+  </ol>
+</details>
+
+<!-- ABOUT THE PROJECT -->
+## About The Project
+
+Proxarr is a lightweight proxy server for automatically qualify requested media items based in countries served by watching providers.
+It uses TMDB to find out which streaming services are available in the selected region.
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+<!-- GETTING STARTED -->
+## Getting Started
+
+### Prerequisites
+
+* Acquire TMDB API KEY
+  [How](https://dev.to/codexive_zech/streamlining-your-contribution-how-to-get-your-tmdb-api-key-for-ldbflix-contribution-52gf#:~:text=How%20to%20Obtain%20a%20TMDB%20API%20Key)
+* Obtain SONARR/RADARR API KEY<br/>
+  <img src="images/arr_api_key.png" width="230">
+
+### Installation
+
+1. Clone the repo
+   ```sh
+   git clone https://github.com/Fazzani/Proxarr.git
+   ```  
+2. Update your [config.yml](./src/Proxarr.Api/config.yml) with your API keys according to your setup
+   ```yaml
+    AppConfiguration:
+    TMDB_API_KEY: "{{ TMDB API KEY}}"
+    TAG_NAME: "q"
+    WATCH_PROVIDERS: "YOUR PROVIDERS HERE seperated by comma (ex: FR:Netflix,US:Amazon Prime Video)"
+    Clients: # Add as many clients as you want
+    - ApiKey: "{{ SONAR OR RADARR API KEY }}"
+      BaseUrl: "{{ SONARR OR RADARR BASE URL }}"
+   ``` 
+
+3. Run the application
+   ```sh
+   dotnet run ./src/Proxarr.Api/Proxarr.Api.csproj
+   ```
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+<!-- USAGE EXAMPLES -->
+## Usage
+
+### Standalone docker container example
+
+```shell
+docker run -itd --rm -e LOG_LEVEL=Debug -p 8880:8880 -v ${PWD}/config:/app/config --name proxarr synker/proxarr:latest
+```
+### Full example with docker compose
+
+```shell
+docker compose -f docker-compose.yml up -d
+```
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+<!-- ROADMAP -->
+## Roadmap
+
+- [ ] Improve Docker tagging with git tag
+- [ ] Remove secrets from code
+- [ ] Add more providers (JustWatch, Reelgood, etc)
+- [ ] Add more tests
+- [ ] Add more documentation
+- [ ] CI/CD pipeline PR
+- [ ] Improve logging and error handling
+- [ ] Full scan library
+- [ ] Api versioning
+
+See the [open issues](https://github.com/Fazzani/Proxarr/issues) for a full list of proposed features (and known issues).
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+<!-- CONTRIBUTING -->
+## 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**.
+
+If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
+Don't forget to give the project a star! Thanks again!
+
+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
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+### Top contributors:
+
+<a href="https://github.com/Fazzani/Proxarr/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=Fazzani/Proxarr" alt="contrib.rocks image" />
+</a>
+
+<!-- LICENSE -->
+## License
+
+Distributed under the project_license. See `LICENSE.txt` for more information.
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+<!-- CONTACT -->
+## Contact
+
+Fazzani - [email protected]
+
+Project Link: [https://github.com/Fazzani/Proxarr](https://github.com/Fazzani/Proxarr)
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+<!-- MARKDOWN LINKS & IMAGES -->
+[contributors-shield]: https://img.shields.io/github/contributors/Fazzani/Proxarr.svg?style=for-the-badge
+[contributors-url]: https://github.com/Fazzani/Proxarr/graphs/contributors
+[forks-shield]: https://img.shields.io/github/forks/Fazzani/Proxarr.svg?style=for-the-badge
+[forks-url]: https://github.com/Fazzani/Proxarr/network/members
+[stars-shield]: https://img.shields.io/github/stars/Fazzani/Proxarr.svg?style=for-the-badge
+[stars-url]: https://github.com/Fazzani/Proxarr/stargazers
+[issues-shield]: https://img.shields.io/github/issues/Fazzani/Proxarr.svg?style=for-the-badge
+[issues-url]: https://github.com/Fazzani/Proxarr/issues
+[license-shield]: https://img.shields.io/github/license/Fazzani/Proxarr.svg?style=for-the-badge
+[license-url]: https://github.com/Fazzani/Proxarr/blob/master/LICENSE.txt
+[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
+[linkedin-url]: https://www.linkedin.com/in/heni-fazzani
+[arr-api-key]: images/arr_api_key.png