commit 354fb7dcfda1e2d0233c277c02355d68ec7a4595 Author: Rod Wright Date: Thu Feb 12 12:48:32 2026 -0500 Initial commit for v1.0.0 diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d5a25a2 --- /dev/null +++ b/LICENSE @@ -0,0 +1,384 @@ +The following license applies to all OpenLog code +Copyright (C) 2016 by Rod Wright : + + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc. + 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your + freedom to share and change it. By contrast, the GNU General Public + License is intended to guarantee your freedom to share and change free + software--to make sure the software is free for all its users. This + General Public License applies to most of the Free Software + Foundation's software and to any other program whose authors commit to + using it. (Some other Free Software Foundation software is covered by + the GNU Library General Public License instead.) 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 + this service 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 make restrictions that forbid + anyone to deny you these rights or to ask you to surrender the rights. + These restrictions translate to certain responsibilities for you if you + distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether + gratis or for a fee, you must give the recipients all the rights that + you have. 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. + + We protect your rights with two steps: (1) copyright the software, and + (2) offer you this license which gives you legal permission to copy, + distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain + that everyone understands that there is no warranty for this free + software. If the software is modified by someone else and passed on, we + want its recipients to know that what they have is not the original, so + that any problems introduced by others will not reflect on the original + authors' reputations. + + Finally, any free program is threatened constantly by software + patents. We wish to avoid the danger that redistributors of a free + program will individually obtain patent licenses, in effect making the + program proprietary. To prevent this, we have made it clear that any + patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and + modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains + a notice placed by the copyright holder saying it may be distributed + under the terms of this General Public License. The \"Program\", below, + refers to any such program or work, and a \"work based on the Program\" + means either the Program or any derivative work under copyright law: + that is to say, a work containing the Program or a portion of it, + either verbatim or with modifications and/or translated into another + language. (Hereinafter, translation is included without limitation in + the term \"modification\".) Each licensee is addressed as \"you\". + + Activities other than copying, distribution and modification are not + covered by this License; they are outside its scope. The act of + running the Program is not restricted, and the output from the Program + is covered only if its contents constitute a work based on the + Program (independent of having been made by running the Program). + Whether that is true depends on what the Program does. + + 1. You may copy and distribute 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 and disclaimer of warranty; keep intact all the + notices that refer to this License and to the absence of any warranty; + and give any other recipients of the Program a copy of this License + along with the Program. + + You may charge a fee for the physical act of transferring a copy, and + you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion + of it, thus forming a work based on the Program, and copy and + distribute such modifications or work under the terms of Section 1 + above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + + These requirements apply to the modified work as a whole. If + identifiable sections of that work are not derived from the Program, + and can be reasonably considered independent and separate works in + themselves, then this License, and its terms, do not apply to those + sections when you distribute them as separate works. But when you + distribute the same sections as part of a whole which is a work based + on the Program, the distribution of the whole must be on the terms of + this License, whose permissions for other licensees extend to the + entire whole, and thus to each and every part regardless of who wrote it. + + Thus, it is not the intent of this section to claim rights or contest + your rights to work written entirely by you; rather, the intent is to + exercise the right to control the distribution of derivative or + collective works based on the Program. + + In addition, mere aggregation of another work not based on the Program + with the Program (or with a work based on the Program) on a volume of + a storage or distribution medium does not bring the other work under + the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, + under Section 2) in object code or executable form under the terms of + Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + + The source code for a work means the preferred form of the work for + making modifications to it. For an executable work, complete source + code means all the source code for all modules it contains, plus any + associated interface definition files, plus the scripts used to + control compilation and installation of the executable. However, as a + special exception, the source code distributed need not include + anything that is normally distributed (in either source or binary + form) with the major components (compiler, kernel, and so on) of the + operating system on which the executable runs, unless that component + itself accompanies the executable. + + If distribution of executable or object code is made by offering + access to copy from a designated place, then offering equivalent + access to copy the source code from the same place counts as + distribution of the source code, even though third parties are not + compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program + except as expressly provided under this License. Any attempt + otherwise to copy, modify, sublicense or distribute the Program is + void, and will automatically terminate your rights under this License. + However, parties who have received copies, or rights, from you under + this License will not have their licenses terminated so long as such + parties remain in full compliance. + + 5. You are not required to accept this License, since you have not + signed it. However, nothing else grants you permission to modify or + distribute the Program or its derivative works. These actions are + prohibited by law if you do not accept this License. Therefore, by + modifying or distributing the Program (or any work based on the + Program), you indicate your acceptance of this License to do so, and + all its terms and conditions for copying, distributing or modifying + the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the + Program), the recipient automatically receives a license from the + original licensor to copy, distribute or modify the Program subject to + these terms and conditions. You may not impose any further + restrictions on the recipients' exercise of the rights granted herein. + You are not responsible for enforcing compliance by third parties to + this License. + + 7. If, as a consequence of a court judgment or allegation of patent + infringement or for any other reason (not limited to patent issues), + 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 + distribute so as to satisfy simultaneously your obligations under this + License and any other pertinent obligations, then as a consequence you + may not distribute the Program at all. For example, if a patent + license would not permit royalty-free redistribution of the Program by + all those who receive copies directly or indirectly through you, then + the only way you could satisfy both it and this License would be to + refrain entirely from distribution of the Program. + + If any portion of this section is held invalid or unenforceable under + any particular circumstance, the balance of the section is intended to + apply and the section as a whole is intended to apply in other + circumstances. + + It is not the purpose of this section to induce you to infringe any + patents or other property right claims or to contest validity of any + such claims; this section has the sole purpose of protecting the + integrity of the free software distribution system, which is + implemented by public license practices. Many people have made + generous contributions to the wide range of software distributed + through that system in reliance on consistent application of that + system; it is up to the author/donor to decide if he or she is willing + to distribute software through any other system and a licensee cannot + impose that choice. + + This section is intended to make thoroughly clear what is believed to + be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in + certain countries either by patents or by copyrighted interfaces, the + original copyright holder who places the Program under this License + may add an explicit geographical distribution limitation excluding + those countries, so that distribution is permitted only in or among + countries not thus excluded. In such case, this License incorporates + the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions + of the 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 a version number of this License which applies to it and \"any + later version\", you have the option of following the terms and conditions + either of that version or of any later version published by the Free + Software Foundation. If the Program does not specify a version number of + this License, you may choose any version ever published by the Free Software + Foundation. + + 10. If you wish to incorporate parts of the Program into other free + programs whose distribution conditions are different, write to the author + to ask for permission. For software which is copyrighted by the Free + Software Foundation, write to the Free Software Foundation; we sometimes + make exceptions for this. Our decision will be guided by the two goals + of preserving the free status of all derivatives of our free software and + of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, 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. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING + WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR + REDISTRIBUTE 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. + + 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 + convey 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 2 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, write to the Free Software + Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + + + Also add information on how to contact you by electronic and paper mail. + + If the program is interactive, make it output a short notice like this + when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision 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, the commands you use may + be called something other than `show w' and `show c'; they could even be + mouse-clicks or menu items--whatever suits your program. + + You should also get your employer (if you work as a programmer) or your + school, if any, to sign a \"copyright disclaimer\" for the program, if + necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + , 1 April 1989 + Ty Coon, President of Vice + + This 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 Library General + Public License instead of this License. + + +The following license applies to jquery code : + + Copyright jQuery Foundation and other contributors, https://jquery.org/ + + This software consists of voluntary contributions made by many + individuals. For exact contribution history, see the revision history + available at https://github.com/jquery/jquery-ui + + The following license applies to all parts of this software except as + documented below: + + ==== + + Permission is hereby granted, free of charge, to any person obtaining + a copy of this software and associated documentation files (the + "Software"), to deal in the Software without restriction, including + without limitation the rights to use, copy, modify, merge, publish, + distribute, sublicense, and/or sell copies of the Software, and to + permit persons to whom the Software is furnished to do so, subject to + the following conditions: + + The above copyright notice and this permission notice shall be + included in all copies or substantial portions of the Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF + MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE + LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION + OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION + WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + + ==== + + Copyright and related rights for sample code are waived via CC0. Sample + code is defined as all source code contained within the demos directory. + + CC0: http://creativecommons.org/publicdomain/zero/1.0/ + diff --git a/README.md b/README.md new file mode 100644 index 0000000..e69de29 diff --git a/distfiles/etc/apache2/conf-available/adminer.conf b/distfiles/etc/apache2/conf-available/adminer.conf new file mode 100644 index 0000000..d6a4bf0 --- /dev/null +++ b/distfiles/etc/apache2/conf-available/adminer.conf @@ -0,0 +1,9 @@ +# Adminer default Apache configuration + +Alias /databases /var/www/adminer + + + AllowOverride Options + Options FollowSymLinks + DirectoryIndex adminer.php + diff --git a/distfiles/opt/adminer/_.htaccess b/distfiles/opt/adminer/_.htaccess new file mode 100644 index 0000000..056e95b --- /dev/null +++ b/distfiles/opt/adminer/_.htaccess @@ -0,0 +1,2 @@ +php_value upload_max_filesize 1G +php_value post_max_size 1G diff --git a/distfiles/usr/local/bin/upgrade-adminer.sh b/distfiles/usr/local/bin/upgrade-adminer.sh new file mode 100644 index 0000000..60ed271 --- /dev/null +++ b/distfiles/usr/local/bin/upgrade-adminer.sh @@ -0,0 +1,18 @@ +#!/bin/bash +# upgrade-adminer.sh + +# test for superuser rights +if [[ $EUID -ne 0 ]]; then + echo "This script must be run with superuser privileges. Try sudo ./upgrade-adminer.sh" + abort_exit +fi + +echo "Getting the latest adminer..." + +mkdir -p /opt/adminer + +sudo -u www-data wget -O /opt/adminer/adminer.php https://www.adminer.org/latest-mysql-en.php + +chown -R www-data:www-data /opt/adminer + +echo "...done." diff --git a/install.sh b/install.sh new file mode 100644 index 0000000..1d8efc2 --- /dev/null +++ b/install.sh @@ -0,0 +1,212 @@ +#!/bin/bash + +# install.sh +# Adminer-Installer +# Copyright (C) 2025 Rod Wright + +# SPDX-License-Identifier: GPL-2.0 + +APP_NAME="Adminer-Installer" +APP_VERSION="1.0" +DOC_ROOT="/var/www" +INSTALL_LOC="/opt/adminer" +APACHE_USER="www-data" +APACHE_GROUP="www-data" +APACHE_CONF_DIR="/etc/apache2/conf-available" + + +function get_new_user() { + # Stores new username in the variable $newusername + ungood=false + while ! $ungood + do + read -p "New username: " -r newusername + if [[ $newusername == "root" || $newusername == "mysql" ]] + then + echo "Username cannot be $newusername. Please try again." + else + ungood=true + fi + done +} + +function get_new_password() { + # Stores new password in the variable $newpassword + pwgood=false + while ! $pwgood + do + read -p "New password: " -s -r newpassword + echo "" + read -p "Re-type new password: " -s -r rnewpw + echo "" + if [ "$newpassword" = "" -o "$rnewpw" = "" ] + then + echo "Password cannot be blank. Please try again." + echo "" + elif [ "$newpassword" != "$rnewpw" ] + then + echo "Passwords do not match. Please try again." + echo "" + else + pwgood=true + fi + done +} + +function install_required_packages() { + # Positional parameters supplied to this function should be quoted + # apt-get installable package names. + # Note: Each package supplied to the for loop below can either be a + # single package name or a list of alternatives separated by the word "or". + # If supplying a list, the last one in the list will be the one that + # gets installed. + for prereq in "$@" + do + echo "Checking for $prereq installation..." + gpattern="" + for pkg_option in $(echo $prereq) + do + if [ "$pkg_option" != "or" ] + then + gpattern+=" -e $pkg_option" + preferred_pkg=$pkg_option + fi + done + if dpkg -l|grep $gpattern >/dev/null 2>&1 + then + echo "$prereq is installed. Continuing." + else + echo "$APP_NAME requires $prereq, but it doesn't seem to be installed. " + echo -n "Install $preferred_pkg now? [Y/n]: " + read reqinstall + if [ "$reqinstall" = "N" -o "$reqinstall" = "n" ] + then + echo "$APP_NAME requires $prereq, but you have elected not to install it." + echo "Installation cannot continue." + abort_exit + else + echo "" + echo "Proceeding with $preferred_pkg installation" + echo "" + sleep 3 + apt-get install -y $preferred_pkg + echo "" + echo "Finished with $preferred_pkg installation" + echo "" + sleep 3 + + fi + fi + done +} + +function clean_exit() { + # Re-enable unattended-upgrades + if $restart_uu; then systemctl start unattended-upgrades; fi + exit 0 +} + +function abort_exit() { + # Re-enable unattended-upgrades + if $restart_uu; then systemctl start unattended-upgrades; fi + exit 1 +} + +function spinner() { + local pid="$1" + local delay="0.1" + local spinstr='|/-\\' + local i=0 + + while ps -p "$pid" > /dev/null; do + i=$(( (i+1) % 4 )) + printf "\r[%c]" "${spinstr:$i:1}" + sleep "$delay" + done + printf "\r \r" # Clear the spinner line +} + +# test for superuser rights +if [[ $EUID -ne 0 ]]; then + echo "This script must be run with superuser privileges. Try sudo ./install.sh" + abort_exit +fi + +echo "" +echo "" +echo "* * * * * Welcome to $APP_NAME $APP_VERSION Installation * * * * *" +echo "" +echo "" +sleep 3 +echo "Preparing for installation. Please wait..." + +# Prevent unattended-upgrades from interfering +restart_uu=false +while dpkg -l|grep unattended-upgrades >/dev/null 2>&1 +do + systemctl stop unattended-upgrades + sleep 5 + restart_uu=true +done + +apt-get update + +# Check for prerequisites and prompt to install +echo "Checking for required packages..." +echo "" +install_required_packages "apache2" "php" "mysql-server or mariadb-server" "php-mysql" "uuid-runtime rsync" +echo "" +echo "Finished required package installation." +echo "" + +# Install distfiles +rsync -avz distfiles/* / + +# Get latest adminer from the official site +wget -O /opt/adminer/adminer.php https://www.adminer.org/latest-mysql-en.php + +# Set symlink to point to adminer +ln -s $INSTALL_LOC $DOC_ROOT/adminer + +# Rename htaccess +mv $INSTALL_LOC/_.htaccess $INSTALL_LOC/.htaccess + +# Set permissions +chown -R $APACHE_USER:$APACHE_GROUP $INSTALL_LOC $DOC_ROOT/adminer + +# Create new database user +echo "IMPORTANT: The default mysql/mariadb installation has only one user," +echo "the root user, which doesn't have a password, and so cannot be used" +echo "to login using Adminer. You'll need to create another database admin" +echo -n "user. Would you like to do that now? [Y/n] :" +read newusercreate +if [[ $newusercreate == "" || $newusercreate == "Y" || $newusercreate == "y" ]] +then + get_new_user + get_new_password + mysql mysql -e "CREATE USER '$newusername'@'localhost' IDENTIFIED BY '$newpassword'" --batch --disable-column-names + mysql mysql -e "GRANT ALL PRIVILEGES on *.* TO '$newusername'@'localhost' WITH GRANT OPTION" --batch --disable-column-names + mysql mysql -e "FLUSH PRIVILEGES" --batch --disable-column-names +else + echo "You will need to manually create a new admin user for the database" + echo "to be able to log in using Adminer." +fi + +echo -n "The apache2 adminer configuration must be enabled. Would you like to do that now? [Y/n] :" +read enconf +if [ "$enconf" = "" -o "$enconf" = "Y" -o "$enconf" = "y" ] +then + a2enconf adminer.conf >/dev/null + systemctl reload apache2 + echo "You can now point a web browser to databases on your web server " + echo "" + echo "This release includes an an updater that fetches the latest stable" + echo "release from the Adminer website. Just run sudo upgrade-adminer.sh" +else + echo "You will need to manually enable the configuration by executing:" + echo " a2enconf adminer.conf" + echo " systemctl reload apache2" + echo "as a superuser before it can be accessed." +fi + +clean_exit