diff --git a/.env b/.env new file mode 100644 index 00000000..c75c843a --- /dev/null +++ b/.env @@ -0,0 +1,10 @@ +#GLOBAL +APP_DATA_LOCATION=/path/to/docker_appdata +APP_CONFIG_LOCATION=/path/to/docker_config +LOGS_LOCATION=/path/to/docker_logs +TZ=Europe/Paris +HOST_USER_ID=1000 +HOST_USER_GID=1000 +PORT=20211 + + diff --git a/.github/workflows/docker.yml b/.github/workflows/docker.yml new file mode 100644 index 00000000..034be97e --- /dev/null +++ b/.github/workflows/docker.yml @@ -0,0 +1,64 @@ +--- +name: docker + +on: + schedule: + - cron: 0 14 * * 0 # every sunday at 14:00 + push: + branches: + - '**' + tags: + - '*.*.*' + pull_request: + branches: + - master + +jobs: + docker: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v2 + + - name: Set up QEMU + uses: docker/setup-qemu-action@v1 + + - name: Set up Docker Buildx + uses: docker/setup-buildx-action@v1 + + - name: Set up dynamic build ARGs + id: getargs + run: echo "::set-output name=version::$(cat ./stable/VERSION)" + + - name: Docker meta + id: meta + uses: docker/metadata-action@v3 + with: + # list of Docker images to use as base name for tags + images: | + jokobsk/pi.alert_consolidation_branch + # generate Docker tags based on the following events/attributes + tags: | + type=raw,value=latest + type=schedule + type=ref,event=branch + type=ref,event=pr + type=semver,pattern={{version}} + type=semver,pattern={{major}}.{{minor}} + type=semver,pattern={{major}} + type=sha + + - name: Login to DockerHub + if: github.event_name != 'pull_request' + uses: docker/login-action@v1 + with: + username: ${{ secrets.DOCKERHUB_USERNAME }} + password: ${{ secrets.DOCKERHUB_TOKEN }} + + - name: Build and push + uses: docker/build-push-action@v2 + with: + platforms: linux/amd64,linux/arm64,linux/arm/v7 + push: ${{ github.event_name != 'pull_request' }} + tags: ${{ steps.meta.outputs.tags }} + labels: ${{ steps.meta.outputs.labels }} diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 00000000..33a47546 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,39 @@ +FROM debian:buster-slim + +# default UID and GID +ENV USER=pi USER_ID=1000 USER_GID=1000 TZ=Europe/London PORT=20211 + +# Todo, figure out why using a workdir instead of full paths don't work +# Todo, do we still need all these packages? I can already see sudo which isn't needed + +RUN apt-get update \ + && apt-get install --no-install-recommends ca-certificates curl libwww-perl arp-scan perl apt-utils cron sudo lighttpd php php-cgi php-fpm php-sqlite3 sqlite3 dnsutils net-tools python iproute2 nmap python-pip -y \ + && pip install requests \ + && apt-get clean autoclean \ + && apt-get autoremove \ + && rm -rf /var/lib/apt/lists/* \ + && ln -s /home/pi/pialert/install/index.html /var/www/html/index.html \ + && ln -s /home/pi/pialert/front /var/www/html/pialert \ + && lighttpd-enable-mod fastcgi-php + + +# now creating user +RUN groupadd --gid "${USER_GID}" "${USER}" && \ + useradd \ + --uid ${USER_ID} \ + --gid ${USER_GID} \ + --create-home \ + --shell /bin/bash \ + ${USER} + +COPY . /home/pi/pialert + +# Pi.Alert +RUN python /home/pi/pialert/back/pialert.py update_vendors \ + && sed -ie 's/= 80/= '${PORT}'/g' /etc/lighttpd/lighttpd.conf \ + && (crontab -l 2>/dev/null; cat /home/pi/pialert/install/pialert.cron) | crontab - + +# it's easy for permissions set in Git to be overridden, so doing it manually +RUN chmod -R a+rxw /home/pi/pialert/ + +CMD ["/home/pi/pialert/dockerfiles/start.sh"] diff --git a/README.md b/README.md index 74a49cc5..23112d77 100644 --- a/README.md +++ b/README.md @@ -10,8 +10,20 @@ unknown devices. It also warns if a "always connected" devices disconnects. *(Apologies for my English and my limited knowledge of Python, php and JavaScript)* +# Docker image 🐳 +[![Docker](https://github.com/jokob-sk/Pi.Alert/actions/workflows/docker.yml/badge.svg)](https://github.com/jokob-sk/Pi.Alert/actions/workflows/docker.yml) +[![Docker Image Size](https://img.shields.io/docker/image-size/jokobsk/pi.alert?logo=Docker)](https://hub.docker.com/r/jokobsk/pi.alert) + + Docker Pulls + + +🥇 Pi.Alert credit goes to [pucherot/Pi.Alert](https://github.com/pucherot/Pi.Alert).
+🐳 Docker Image: [jokobsk/Pi.Alert](https://registry.hub.docker.com/r/jokobsk/pi.alert).
+📄 [Dockerfile](https://github.com/jokob-sk/Pi.Alert/blob/main/Dockerfile)
+📚 [Dockerfile instructions](https://github.com/jokob-sk/Pi.Alert/blob/main//dockerfiles/README.md). + ![Main screen dark][main_dark] -optional Darkmode within this fork +Dark mode (and Device presence over time) within this fork courtesy of [leiweibau](https://github.com/leiweibau/Pi.Alert) ## How it works The system continuously scans the network for: @@ -50,7 +62,14 @@ In charge of: | -------------------- | -------------------- | ### Front -There is a configurable login to prevent unauthorized use. The default password is "123456" +There is a configurable login to prevent unauthorized use. + +> * Set `PIALERT_WEB_PROTECTION = True` in `pialert.conf` to enable +> * The default password is `123456` +> * Set a new password by running `/config/reset_password.sh newpassword` +> * The script creates a backup of the config file `pialert.conf.bak` +> * The password is stored as a sha256 hash + A web frontend that allows: - Manage the devices inventory and the characteristics @@ -64,7 +83,7 @@ A web frontend that allows: - Down alerts - IP's - Manual Nmap scans - - Optional speedtest for Device "Internet" in the details view + - Optional speedtest for Device "Internet" - ... | ![Screen 1][screen1] | ![Screen 2][screen2] | @@ -149,7 +168,7 @@ Linux distributions. pi.alert.application@gmail.com ***Suggestions and comments are welcome*** - + ### Special thanks 🥇 This code is a collaborative body of work, with special thanks to: @@ -159,6 +178,7 @@ Linux distributions. - [Final-Hawk](https://github.com/Final-Hawk): Help with NTFY, styling and other fixes - [terorero](https://github.com/terorero): Spanish translation - [jokob-sk](https://github.com/jokob-sk/Pi.Alert): DB Maintenance tools + - Please see the [Git commit history](https://github.com/jokob-sk/Pi.Alert/commits/main) for a full list of people and their contributions to the project [main]: ./docs/img/1_devices.jpg "Main screen" diff --git a/back/pialert.py b/back/pialert.py index 1dd6278d..5930599f 100644 --- a/back/pialert.py +++ b/back/pialert.py @@ -27,9 +27,7 @@ import socket import io import smtplib import csv -from urllib.parse import urlencode -from urllib.request import Request, urlopen - +import requests #=============================================================================== # CONFIG CONSTANTS @@ -77,6 +75,9 @@ def main (): return cycle = str(sys.argv[1]) + ## Upgrade DB if needed + upgradeDB() + ## Main Commands if cycle == 'internet_IP': res = check_internet_IP() @@ -355,7 +356,7 @@ def scan_network (): # ScanCycle data cycle_interval = scanCycle_data['cic_EveryXmin'] - arpscan_retries = scanCycle_data['cic_arpscanCycles'] + # arpscan_retries = scanCycle_data['cic_arpscanCycles'] no longer needed # TESTING - Fast scan # arpscan_retries = 1 @@ -363,7 +364,7 @@ def scan_network (): print ('\nScanning...') print (' arp-scan Method...') print_log ('arp-scan starts...') - arpscan_devices = execute_arpscan (arpscan_retries) + arpscan_devices = execute_arpscan () print_log ('arp-scan ends') # DEBUG - print number of rows updated # print (arpscan_devices) @@ -449,16 +450,23 @@ def query_ScanCycle_Data (pOpenCloseDB = False): return sqlRow #------------------------------------------------------------------------------- -def execute_arpscan (pRetries): +def execute_arpscan (): # #101 - arp-scan subnet configuration # Prepare command arguments subnets = SCAN_SUBNETS.strip().split() - + + # ---------------START----------------Rollback-----------------START--------------- + # rolled-back to previous code - arp-scan wouldn't discover all devices # arp-scan for larger Networks like /16 # otherwise the system starts multiple processes. the 15min cronjob isn't necessary. # the scan is about 4min on a /16 network - arpscan_args = ['sudo', 'arp-scan', '--ignoredups', '--bandwidth=512k', '--retry=3', SCAN_SUBNETS] + + # Rolled back line(FROM) : + #arpscan_args = ['sudo', 'arp-scan', '--ignoredups', '--bandwidth=512k', '--retry=3', SCAN_SUBNETS] + # Rolled back line(TO) : + arpscan_args = ['sudo', 'arp-scan', '--ignoredups', '--retry=6'] + subnets + # ---------------END------------------Rollback-----------------END--------------- # Default arp-scan # arpscan_args = ['sudo', 'arp-scan', SCAN_SUBNETS, '--ignoredups', '--retry=' + str(pRetries)] @@ -703,15 +711,18 @@ def print_scan_stats (): sql.execute("SELECT * FROM Devices") History_All = sql.fetchall() History_All_Devices = len(History_All) + sql.execute("SELECT * FROM Devices WHERE dev_Archived = 1") History_Archived = sql.fetchall() History_Archived_Devices = len(History_Archived) - sql.execute("SELECT * FROM CurrentScan") + + sql.execute("""SELECT * FROM CurrentScan WHERE cur_ScanCycle = ? """, (cycle,)) History_Online = sql.fetchall() History_Online_Devices = len(History_Online) History_Offline_Devices = History_All_Devices - History_Archived_Devices - History_Online_Devices - sql.execute ("INSERT INTO Online_History (Scan_Date, Online_Devices, Down_Devices, All_Devices, Archived_Devices, ScanCycle) "+ - "VALUES ( ?, ?, ?, ?, ?, ?)", (startTime, History_Online_Devices, History_Offline_Devices, History_All_Devices, History_Archived_Devices, cycle ) ) + + sql.execute ("INSERT INTO Online_History (Scan_Date, Online_Devices, Down_Devices, All_Devices, Archived_Devices) "+ + "VALUES ( ?, ?, ?, ?, ?)", (startTime, History_Online_Devices, History_Offline_Devices, History_All_Devices, History_Archived_Devices ) ) #------------------------------------------------------------------------------- def create_new_devices (): @@ -955,11 +966,11 @@ def update_devices_data_from_scan (): recordsToUpdate ) # New Apple devices -> Cycle 15 - print_log ('Update devices - 6 Cycle for Apple devices') - sql.execute ("""UPDATE Devices SET dev_ScanCycle = 1 - WHERE dev_FirstConnection = ? - AND UPPER(dev_Vendor) LIKE '%APPLE%' """, - (startTime,) ) + # print_log ('Update devices - 6 Cycle for Apple devices') + # sql.execute ("""UPDATE Devices SET dev_ScanCycle = 1 + # WHERE dev_FirstConnection = ? + # AND UPPER(dev_Vendor) LIKE '%APPLE%' """, + # (startTime,) ) print_log ('Update devices end') @@ -1187,7 +1198,6 @@ def skip_repeated_notifications (): def email_reporting (): global mail_text global mail_html - # Reporting section print ('\nReporting...') openDB() @@ -1199,9 +1209,6 @@ def email_reporting (): SELECT dev_MAC FROM Devices WHERE dev_AlertEvents = 0 )""") - # Open text Template - - # Open text Template template_file = open(PIALERT_BACK_PATH + '/report_template.txt', 'r') mail_text = template_file.read() @@ -1247,16 +1254,18 @@ def email_reporting (): WHERE eve_PendingAlertEmail = 1 AND eve_MAC = 'Internet' ORDER BY eve_DateTime""") + for eventAlert in sql : mail_section_Internet = True mail_text_Internet += text_line_template.format ( - eventAlert['eve_EventType'], eventAlert['eve_DateTime'], - eventAlert['eve_IP'], eventAlert['eve_AdditionalInfo']) + 'Event:', eventAlert['eve_EventType'], 'Time:', eventAlert['eve_DateTime'], + 'IP:', eventAlert['eve_IP'], 'More Info:', eventAlert['eve_AdditionalInfo']) mail_html_Internet += html_line_template.format ( REPORT_DEVICE_URL, eventAlert['eve_MAC'], eventAlert['eve_EventType'], eventAlert['eve_DateTime'], eventAlert['eve_IP'], eventAlert['eve_AdditionalInfo']) + format_report_section (mail_section_Internet, 'SECTION_INTERNET', 'TABLE_INTERNET', mail_text_Internet, mail_html_Internet) @@ -1283,7 +1292,7 @@ def email_reporting (): REPORT_DEVICE_URL, eventAlert['eve_MAC'], eventAlert['eve_MAC'], eventAlert['eve_DateTime'], eventAlert['eve_IP'], eventAlert['dev_Name'], eventAlert['eve_AdditionalInfo']) - + format_report_section (mail_section_new_devices, 'SECTION_NEW_DEVICES', 'TABLE_NEW_DEVICES', mail_text_new_devices, mail_html_new_devices) @@ -1358,6 +1367,11 @@ def email_reporting (): send_email (mail_text, mail_html) else : print (' Skip mail...') + if REPORT_NTFY : + print (' Sending report by NTFY...') + send_ntfy (mail_text) + else : + print (' Skip NTFY...') if REPORT_PUSHSAFER : print (' Sending report by PUSHSAFER...') send_pushsafer (mail_text) @@ -1387,8 +1401,16 @@ def email_reporting (): # Commit changes sql_connection.commit() closeDB() - #------------------------------------------------------------------------------- +def send_ntfy (_Text): + requests.post("https://ntfy.sh/{}".format(NTFY_TOPIC), + data=_Text, + headers={ + "Title": "Pi.Alert Notification", + "Click": REPORT_DASHBOARD_URL, + "Priority": "urgent", + "Tags": "warning" + }) def send_pushsafer (_Text): url = 'https://www.pushsafer.com/api' @@ -1511,6 +1533,46 @@ def SafeParseGlobalBool(boolVariable): #=============================================================================== # DB #=============================================================================== +def upgradeDB (): + + openDB() + + # indicates, if Online_History table is available + onlineHistoryAvailable = sql.execute(""" + SELECT name FROM sqlite_master WHERE type='table' + AND name='Online_History'; + """).fetchall() != [] + + # Check if it is incompatible (Check if table has all required columns) + isIncompatible = False + + if onlineHistoryAvailable : + isIncompatible = sql.execute (""" + SELECT COUNT(*) AS CNTREC FROM pragma_table_info('Online_History') WHERE name='Archived_Devices' + """).fetchone()[0] == 0 + + # Drop table if available, but incompatible + if onlineHistoryAvailable and isIncompatible: + print_log ('Table is incompatible, Dropping the Online_History table)') + sql.execute("DROP TABLE Online_History;") + onlineHistoryAvailable = False + + if onlineHistoryAvailable == False : + sql.execute(""" + CREATE TABLE "Online_History" ( + "Index" INTEGER, + "Scan_Date" TEXT, + "Online_Devices" INTEGER, + "Down_Devices" INTEGER, + "All_Devices" INTEGER, + "Archived_Devices" INTEGER, + PRIMARY KEY("Index" AUTOINCREMENT) + ); + """) + + +#------------------------------------------------------------------------------- + def openDB (): global sql_connection global sql diff --git a/config/pialert.conf b/config/pialert.conf index 42f82997..d1531486 100644 --- a/config/pialert.conf +++ b/config/pialert.conf @@ -29,6 +29,10 @@ REPORT_TO = 'user@gmail.com' REPORT_DEVICE_URL = 'http://pi.alert/deviceDetails.php?mac=' REPORT_DASHBOARD_URL = 'http://pi.alert/' +REPORT_NTFY = False +REPORT_DASHBOARD_URL = 'http://pi.alert/' +NTFY_TOPIC = 'replace-my-secure-topicname-91h889f28' + REPORT_PUSHSAFER = False PUSHSAFER_TOKEN = 'ApiKey' diff --git a/config/version.conf b/config/version.conf index 60c442de..7110989f 100644 --- a/config/version.conf +++ b/config/version.conf @@ -1,3 +1,4 @@ VERSION = '3.5_leiweibau' VERSION_YEAR = '2022' VERSION_DATE = '2022-07-07' +TZ = 'Europe/London' \ No newline at end of file diff --git a/db/pialert.db b/db/pialert.db index 0d78af64..ff4e2731 100644 Binary files a/db/pialert.db and b/db/pialert.db differ diff --git a/docker-compose.yml b/docker-compose.yml new file mode 100644 index 00000000..b1ec288d --- /dev/null +++ b/docker-compose.yml @@ -0,0 +1,16 @@ +version: "3" +services: + pialert: + build: . + container_name: pialert + network_mode: "host" + restart: always + volumes: + - ${APP_DATA_LOCATION}/pialert/config:/home/pi/pialert/config + - ${APP_DATA_LOCATION}/pialert/db/pialert.db:/home/pi/pialert/db/pialert.db + - ${LOGS_LOCATION}/tmp:/home/pi/pialert/log + environment: + - TZ=${TZ} + - PORT=${PORT} + - HOST_USER_ID=${HOST_USER_ID} + - HOST_USER_GID=${HOST_USER_GID} diff --git a/dockerfiles/LICENSE b/dockerfiles/LICENSE new file mode 100644 index 00000000..3877ae0a --- /dev/null +++ b/dockerfiles/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/dockerfiles/README.md b/dockerfiles/README.md new file mode 100644 index 00000000..17a4bbce --- /dev/null +++ b/dockerfiles/README.md @@ -0,0 +1,108 @@ +[![Docker](https://github.com/jokob-sk/Pi.Alert/actions/workflows/docker.yml/badge.svg)](https://github.com/jokob-sk/Pi.Alert/actions/workflows/docker.yml) +[![Docker Image Size](https://img.shields.io/docker/image-size/jokobsk/pi.alert?logo=Docker)](https://hub.docker.com/r/jokobsk/pi.alert) + + Docker Pulls + + +# 🐳 A docker image for Pi.Alert + +🥇 Pi.Alert credit goes to [pucherot/Pi.Alert](https://github.com/pucherot/Pi.Alert).
+🐳 Docker Image: [jokobsk/Pi.Alert](https://registry.hub.docker.com/r/jokobsk/pi.alert).
+📄 [Dockerfile](https://github.com/jokob-sk/Pi.Alert/blob/main/Dockerfile)
+📚 [Dockerfile instructions](https://github.com/jokob-sk/Pi.Alert/blob/main//dockerfiles/README.md). + +Big thanks to @Macleykun for help and tips&tricks for Dockerfile(s): + + + + + +## ℹ Usage + +Network + - You will have to probably run the container on the host network, e.g: `sudo docker run --rm --net=host jokobsk/pi.alert` + +Default Port + - The app is accessible on the port `:20211`. + +> Please note - the cronjob is executed every 1, 5 and 15 minutes so wait that long for all of the scans to run. + +## 💾 Setup and Backups + +1. (**required**) Download `pialert.conf` and `version.conf` from [here](https://github.com/jokob-sk/Pi.Alert/tree/main/config). +2. (**required**) In `pialert.conf` specify your network adapter (will probably be `eth0` or `eth1`) and the network filter (which **significantly** speeds up the scan process), e.g. if your DHCP server assigns IPs in the 192.168.1.0 to 192.168.1.255 range specify it the following way: + * `SCAN_SUBNETS = '192.168.1.0/24 --interface=eth0'` +3. (**required**) Use your configuration by: + * Mapping the container folder `/home/pi/pialert/config` to a persistent folder containing `pialert.conf` and `version.conf`, + * ... or by mapping the files individually `pialert.conf:/home/pi/pialert/config/pialert.conf` and `version.conf:/home/pi/pialert/config/version.conf` +4. Set the `TZ` environment variable to your current time zone (e.g.`Europe/Paris`). Find your time zone [here](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). +5. Database backup + * The DB is stored under `/home/pi/pialert/db/pialert.db`. Map this file to a persistent location (see [Examples](https://github.com/jokob-sk/Pi.Alert/tree/main/dockerfiles#page_facing_up-examples) for details). If facing issues (AJAX errors, can't write to DB, etc, make sure permissions are set correctly, alternatively check the logs under `/home/pi/pialert/log`) +6. The container supports mapping to local User nad Group IDs. Specify the enviroment variables `HOST_USER_ID` and `HOST_USER_GID` if needed. +7. You can override the port by specifying the `PORT` env variable. + +Config examples can be found below. + +## 📄 Examples + +### Example 1 + +`docker-compose.yml` + +```yaml +version: "3" +services: + pialert: + container_name: pialert + image: "jokobsk/pi.alert:latest" + network_mode: "host" + restart: always + volumes: + - ${APP_DATA_LOCATION}/pialert/config:/home/pi/pialert/config + - ${APP_DATA_LOCATION}/pialert/db/pialert.db:/home/pi/pialert/db/pialert.db + - ${LOGS_LOCATION}/:/home/pi/pialert/log + environment: + - TZ=Europe/London + - PORT=20211 + - HOST_USER_ID=1000 + - HOST_USER_GID=1000 +``` + +`.env` file + +```yaml + +APP_DATA_LOCATION=/path/to/docker_appdata +APP_CONFIG_LOCATION=/path/to/docker_config +LOGS_LOCATION=/path/to/docker_logs + +``` + +To run the container execute: `sudo docker-compose --env-file /path/to/.env up` + +### Example 2 + +Courtesy of [pbek](https://github.com/pbek). The volume `pialert_db` is used by the db directory. The two config files are mounted directly from a local folder to their places in the config folder. You can backup the `docker-compose.yaml` folder and the docker volumes folder. + +```yaml + pialert: + image: jokobsk/pi.alert + ports: + - "80:20211/tcp" + environment: + - TZ=Europe/Vienna + networks: + local: + ipv4_address: 192.168.1.2 + restart: unless-stopped + volumes: + - pialert_db:/home/pi/pialert/db + - ./pialert/pialert.conf:/home/pi/pialert/config/pialert.conf + - ./pialert/version.conf:/home/pi/pialert/config/version.conf +``` + +## ☕ Support + +> Disclaimer: This is my second container and I might have used unconventional hacks so if anyone is more experienced, feel free to fork/create pull requests. Also, please only donate if you don't have any debt yourself. Support yourself first, then others. + +Buy Me A Coffee diff --git a/dockerfiles/start.sh b/dockerfiles/start.sh new file mode 100755 index 00000000..3ab58572 --- /dev/null +++ b/dockerfiles/start.sh @@ -0,0 +1,14 @@ +#!/bin/sh +/home/pi/pialert/dockerfiles/user-mapping.sh + +# if custom variables not set we do not need to do anything +if [ -n "${TZ}" ]; then + sed -ie "s|Europe/London|${TZ}|g" /home/pi/pialert/install/pialert.cron + crontab < /home/pi/pialert/install/pialert.cron +fi +if [ -n "${PORT}" ]; then + sed -ie 's/= 20211/= '${PORT}'/g' /etc/lighttpd/lighttpd.conf +fi + +/etc/init.d/lighttpd start +cron -f diff --git a/dockerfiles/user-mapping.sh b/dockerfiles/user-mapping.sh new file mode 100644 index 00000000..54803092 --- /dev/null +++ b/dockerfiles/user-mapping.sh @@ -0,0 +1,29 @@ +#!/bin/bash + +if [ -z "${USER}" ]; then + echo "We need USER to be set!"; exit 100 +fi + +# if both not set we do not need to do anything +if [ -z "${HOST_USER_ID}" -a -z "${HOST_USER_GID}" ]; then + echo "Nothing to do here." ; exit 0 +fi + +# reset user_?id to either new id or if empty old (still one of above +# might not be set) +USER_ID=${HOST_USER_ID:=$USER_ID} +USER_GID=${HOST_USER_GID:=$USER_GID} + +LINE=$(grep -F "${USER}" /etc/passwd) +# replace all ':' with a space and create array +array=( ${LINE//:/ } ) + +# home is 5th element +USER_HOME=${array[4]} + +sed -i -e "s/^${USER}:\([^:]*\):[0-9]*:[0-9]*/${USER}:\1:${USER_ID}:${USER_GID}/" /etc/passwd +sed -i -e "s/^${USER}:\([^:]*\):[0-9]*/${USER}:\1:${USER_GID}/" /etc/group + +chown -R ${USER_ID}:${USER_GID} ${USER_HOME} + +exec su - "${USER}" \ No newline at end of file diff --git a/docs/img/1_devices.jpg b/docs/img/1_devices.jpg index 7cd18cb0..4f0a499c 100644 Binary files a/docs/img/1_devices.jpg and b/docs/img/1_devices.jpg differ diff --git a/docs/img/1_devices_dark.jpg b/docs/img/1_devices_dark.jpg index 1314cbf7..1b768f8f 100644 Binary files a/docs/img/1_devices_dark.jpg and b/docs/img/1_devices_dark.jpg differ diff --git a/docs/img/2_1_device_details.jpg b/docs/img/2_1_device_details.jpg index ba001077..90ad2133 100644 Binary files a/docs/img/2_1_device_details.jpg and b/docs/img/2_1_device_details.jpg differ diff --git a/docs/img/2_2_device_sessions.jpg b/docs/img/2_2_device_sessions.jpg index 32f88447..063c63c1 100644 Binary files a/docs/img/2_2_device_sessions.jpg and b/docs/img/2_2_device_sessions.jpg differ diff --git a/docs/img/2_3_device_presence.jpg b/docs/img/2_3_device_presence.jpg index 7ab0123e..b74fd744 100644 Binary files a/docs/img/2_3_device_presence.jpg and b/docs/img/2_3_device_presence.jpg differ diff --git a/docs/img/2_4_device_nmap.jpg b/docs/img/2_4_device_nmap.jpg index d9f295fe..301b6744 100644 Binary files a/docs/img/2_4_device_nmap.jpg and b/docs/img/2_4_device_nmap.jpg differ diff --git a/docs/img/2_5_device_nmap_ready.jpg b/docs/img/2_5_device_nmap_ready.jpg index 8d6baa70..6184fa49 100644 Binary files a/docs/img/2_5_device_nmap_ready.jpg and b/docs/img/2_5_device_nmap_ready.jpg differ diff --git a/docs/img/3_presence.jpg b/docs/img/3_presence.jpg index b619e46f..7589dcca 100644 Binary files a/docs/img/3_presence.jpg and b/docs/img/3_presence.jpg differ diff --git a/docs/img/5_maintain.jpg b/docs/img/5_maintain.jpg index bfa68e09..69c2f569 100644 Binary files a/docs/img/5_maintain.jpg and b/docs/img/5_maintain.jpg differ diff --git a/front/css/dark-patch.css b/front/css/dark-patch.css index d49882d7..97738f34 100644 --- a/front/css/dark-patch.css +++ b/front/css/dark-patch.css @@ -594,7 +594,42 @@ input[type="password"]::-webkit-caps-lock-indicator { } /*** Additional fixes For Pi.Alert UI ***/ - +.small-box { + border-radius: 10px; + border-top: 0px; +} +.pa-small-box-aqua .inner { + background-color: rgb(45,108,133); + border-top-left-radius: 10px; + border-top-right-radius: 10px; +} +.pa-small-box-green .inner { + background-color: rgb(31,76,46); + border-top-left-radius: 10px; + border-top-right-radius: 10px; +} +.pa-small-box-yellow .inner { + background-color: rgb(151,104,37); + border-top-left-radius: 10px; + border-top-right-radius: 10px; +} +.pa-small-box-red .inner { + background-color: rgb(120,50,38); + border-top-left-radius: 10px; + border-top-right-radius: 10px; +} +.pa-small-box-gray .inner { + background-color: #777; + /* color: rgba(20,20,20,30%); */ + border-top-left-radius: 10px; + border-top-right-radius: 10px; +} +.pa-small-box-gray .inner h3 { + color: #bbb; +} +.text-gray-20 { + color: rgba(220,220,220,30%); +} .bg-gray { background-color: #888888 !important; } @@ -629,24 +664,6 @@ input[type="password"]::-webkit-caps-lock-indicator { margin: auto; } -.nav-tabs-custom > .nav-tabs > li:hover > a, .nav-tabs-custom > .nav-tabs > li.active:hover > a { - background-color: #272c30; - color: #bec5cb; -} - -.nav-tabs-custom > .nav-tabs > li.active > a, .nav-tabs-custom > .nav-tabs > li.active:hover > a { - border-left-color: #30383f; - border-right-color: #30383f; - background-color: #272c30; - color: #bec5cb; -} -.nav-tabs-custom .tab-content { - background-color: #272c30; -} -.top_small_box_gray_text { - color: white !important; -} - /* remove white border that appears on mobile screen sizes */ .box-body { border: 0px; @@ -667,4 +684,21 @@ input[type="password"]::-webkit-caps-lock-indicator { .login-box-body { color: #bec5cb; background-color: #272c30; -} \ No newline at end of file +} +/* Add border radius to bottom of the status boxes*/ +.pa-small-box-footer { + border-bottom-left-radius: 10px; + border-bottom-right-radius: 10px; +} + +.small-box > .inner h3, .small-box > .inner p { + margin-bottom: 0px; + margin-left: 0px; +} +.small-box:hover .icon { + font-size: 3.74em; +} +.small-box .icon { + top: 0.01em; + font-size: 3.25em; +} diff --git a/front/devices.php b/front/devices.php index f0033d05..071f0c02 100644 --- a/front/devices.php +++ b/front/devices.php @@ -114,7 +114,7 @@ if ($_SESSION["login"] != 1)
-

12

+

@@ -237,6 +237,12 @@ function main () { // ----------------------------------------------------------------------------- function initializeDatatable () { + // If the device has a small width (mobile) only show name, ip, and status columns. + if (window.screen.width < 400) { + var tableColumnShow = [10,11,12,1,2,3,4,5,6,8]; + } else { + var tableColumnShow = [10, 11, 12]; + }; var table= $('#tableDevices').DataTable({ 'paging' : true, @@ -254,7 +260,7 @@ function initializeDatatable () { // 'order' : [[3,'desc'], [0,'asc']], 'columnDefs' : [ - {visible: false, targets: [10, 11, 12] }, + {visible: false, targets: tableColumnShow }, {className: 'text-center', targets: [3, 8, 9] }, {width: '80px', targets: [5, 6] }, {width: '0px', targets: 9 }, diff --git a/front/maintenance.php b/front/maintenance.php index 50db2ae1..152399ad 100644 --- a/front/maintenance.php +++ b/front/maintenance.php @@ -332,6 +332,9 @@ if (submit && isset($_POST['langselector_set'])) {
+ +
+
@@ -483,6 +486,20 @@ function PiaToggleArpScan() }); } +// upgrade DB +function askUpgradeDatabase () { + // Ask + showModalWarning('', '', + 'Cancel', 'Upgrade', 'upgradeDatabase'); +} +function upgradeDatabase() +{ + // Upgrade DB + $.get('php/server/devices.php?action=upgradeDatabase', function(msg) { + showMessage (msg); + }); +} + diff --git a/front/php/server/devices.php b/front/php/server/devices.php index b317bb25..48aea177 100644 --- a/front/php/server/devices.php +++ b/front/php/server/devices.php @@ -36,6 +36,7 @@ if (strlen($pia_lang_selected) == 0) {$pia_lang_selected = 'en_us';} case 'setDeviceData': setDeviceData(); break; case 'deleteDevice': deleteDevice(); break; case 'deleteAllWithEmptyMACs': deleteAllWithEmptyMACs(); break; + case 'upgradeDatabase': upgradeDB(); break; case 'createBackupDB': createBackupDB(); break; case 'restoreBackupDB': restoreBackupDB(); break; case 'deleteAllDevices': deleteAllDevices(); break; @@ -212,6 +213,36 @@ function deleteAllWithEmptyMACs() { } } +//------------------------------------------------------------------------------ +// Upgrade the database to enable new functionality +//------------------------------------------------------------------------------ +function upgradeDB() { + global $db; + global $pia_lang; + + // sql + $sql = ' + -- Online_History definition + + CREATE TABLE "Online_History" ( + "Index" INTEGER, + "Scan_Date" TEXT, + "Online_Devices" INTEGER, + "Down_Devices" INTEGER, + "All_Devices" INTEGER, + PRIMARY KEY("Index" AUTOINCREMENT) + );'; + // execute sql + $result = $db->query($sql); + + // check result + if ($result == TRUE) { + echo $pia_lang['BackDevices_DBTools_Upgrade']; + } else { + echo $pia_lang['BackDevices_DBTools_UpgradeError']."\n\n$sql \n\n". $db->lastErrorMsg(); + } +} + //------------------------------------------------------------------------------ // Delete all devices with empty MAC addresses //------------------------------------------------------------------------------ diff --git a/front/php/templates/header.php b/front/php/templates/header.php index ce9284b1..a9d2fee5 100644 --- a/front/php/templates/header.php +++ b/front/php/templates/header.php @@ -102,6 +102,12 @@ if ($ENABLED_DARKMODE === True) {