adguard-home-manager/README.md

119 lines
5.1 KiB
Markdown
Raw Normal View History

2022-12-01 01:42:18 +01:00
<h1 align="center">
2022-12-01 01:54:39 +01:00
<img src="https://github.com/JGeek00/adguard-home-manager/raw/master/assets/other/banner.png" />
2022-12-01 01:42:18 +01:00
</h1>
2022-12-01 01:42:18 +01:00
<h5 align="center">
2022-12-01 01:58:50 +01:00
<b>
AdGuard Home Manager is an
<a href="https://adguard.com/es/adguard-home/overview.html" target="_blank" rel="noopener noreferrer">
AdGuard Home
</a>
unofficial client developed with Flutter.</b>
2022-12-01 01:42:18 +01:00
</h5>
<p align="center">
2022-12-01 01:56:01 +01:00
<a href="https://play.google.com/store/apps/details?id=com.jgeek00.adguard_home_manager" target="_blank" rel="noopener noreferrer">
<img src="/assets/other/get_google_play.png" width="300px">
2022-12-01 01:42:18 +01:00
</a>
2022-12-01 02:02:14 +01:00
<a href="https://github.com/JGeek00/adguard-home-manager/releases" target="_blank" rel="noopener noreferrer">
<img src="/assets/other/get-github.png" width="300px">
</a>
2022-12-01 01:42:18 +01:00
</p>
2022-10-04 16:10:33 +02:00
2022-09-30 11:40:44 +02:00
## Main features
<p>▶ Manage your AdGuard Home server on an easy way.</p>
<p>▶ Supports HTTP and HTTPS connections.</p>
<p>▶ Enable and disable the different protections with only one switch.</p>
<p>▶ Add multiple servers to the app, and manage all of them from here.</p>
2022-10-24 03:00:02 +02:00
<p>▶ See and filter the query logs.</p>
<p>▶ Manage your filtering lists.</p>
<p>▶ See the clients list and create a custom configuration for a client.</p>
<p>▶ Configure the allowed devices, DHCP, DNS or rewrites among others.</p>
<p>▶ Material You interface with dynamic theming (only Android 12+).</p>
2023-05-04 04:04:38 +02:00
<p>▶ Full desktop support with builds for macOS, Linux and Windows.</p>
<p>▶ Responsive UI adapted for landscape displays.</p>
2022-09-30 11:40:44 +02:00
## Privacy policy
AdGuard Home Manager does not collect any personal user data. All data stored into the application is kept on the user's device.
## Disclaimer
This is an unofficial application. The AdGuard Home team and the development of the AdGuard Home software is not related in any way with this application.
2023-03-20 04:29:50 +01:00
## Recommended configuration and lists
On [this repository](https://github.com/JuanRodenas/Pihole_list) you can find a recommended configuration for AdGuard Home and some lists. Thanks to [JuanRodenas](https://github.com/JuanRodenas).
2023-05-04 04:04:38 +02:00
## Generate production build
<ul>
<li>
<b>macOS</b>
<ol>
<li>flutter clean</li>
<li>flutter pub get</li>
<li>flutter build macos --release</li>
<li>Open macos/Runner.xcworkspace on Xcode</li>
<li>Make sure all the pods have the minimum deployment version at 10.14</li>
<li>Select Runner > Targets Runner</li>
<li>Make sure the Version and Build numbers are correct</li>
<li>Click on Product menu and on Archive</li>
<li>Select the first on the list and click on Distribute app, select Copy App and click on Next</li>
</ol>
</li>
<li>
<b>Linux</b>
<ol>
<li>flutter clean</li>
<li>flutter pub get</li>
<li>flutter build linux --release</li>
<li>Open debian.yaml file inside debian/ and update the version number</li>
<li>Run flutter_to_debian</li>
<li>The .deb package is at debian/packages</li>
</ol>
</li>
<li>
<b>Windows</b>
<ol>
<li>flutter clean</li>
<li>flutter pub get</li>
<li>flutter build windows</li>
<li>Open Inno Setup Compiler application and load the script</li>
<li>The script is located at windows/innosetup_installer_builder.iss</li>
<li>Update the version number and save the changes</li>
<li>Click on the Compile button</li>
<li>The installer will be generated at build/windows/aghm_installer.exe</li>
</ol>
</li>
</ul>
2022-09-30 11:40:44 +02:00
## Third party libraries
- [provider](https://pub.dev/packages/provider)
- [sqflite](https://pub.dev/packages/sqflite)
- [http](https://pub.dev/packages/http)
- [expandable](https://pub.dev/packages/expandable)
- [package info plus](https://pub.dev/packages/package_info_plus)
- [flutter phoenix](https://pub.dev/packages/flutter_phoenix)
- [flutter displaymode](https://pub.dev/packages/flutter_displaymode)
- [flutter launcher icons](https://pub.dev/packages/flutter_launcher_icons)
- [flutter native splash](https://pub.dev/packages/flutter_native_splash)
- [intl](https://pub.dev/packages/intl)
- [animations](https://pub.dev/packages/animations)
- [dynamic color](https://pub.dev/packages/dynamic_color)
- [device info](https://pub.dev/packages/device_info)
2022-10-04 16:10:33 +02:00
- [fl chart](https://pub.dev/packages/fl_chart)
- [flutter web browser](https://pub.dev/packages/flutter_web_browser)
- [flutter svg](https://pub.dev/packages/flutter_svg)
2022-10-09 18:49:55 +02:00
- [bottom sheet](https://pub.dev/packages/bottom_sheet)
2022-10-25 20:02:48 +02:00
- [percent indicator](https://pub.dev/packages/percent_indicator)
2022-10-29 18:40:07 +02:00
- [store checker](https://pub.dev/packages/store_checker)
2023-05-04 04:04:38 +02:00
- [flutter markdown](https://pub.dev/packages/flutter_markdown)
- [markdown](https://pub.dev/packages/markdown)
- [html](https://pub.dev/packages/html)
- [flutter html](https://pub.dev/packages/flutter_html)
- [sqlite3 flutter libs](https://pub.dev/packages/sqlite3_flutter_libs)
- [sqflite common ffi](https://pub.dev/packages/sqflite_common_ffi)
- [window size](https://github.com/google/flutter-desktop-embedding)
- [flutter split view](https://github.com/JGeek00/flutter_split_view) (forked from [here](https://pub.dev/packages/flutter_split_view))
2022-09-30 11:40:44 +02:00
2022-09-26 13:55:16 +02:00
<br>
2023-03-20 04:29:50 +01:00
##### Created by JGeek00