baldnerd/git-server-appliance
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

First commit on self-hosted cloud

Browse Source
This commit is contained in:
Category5 TV Network
2025-06-20 11:21:53 -04:00
parent a47e8f6209
commit 6de2f8f516
6 changed files with 665 additions and 43 deletions
Download Patch File Download Diff File Expand all files Collapse all files

210
LICENSE
View File

@ -1,73 +1,201 @@
Apache License Apache License
Version 2.0, January 2004 Version 2.0, January 2004
http://www.apache.org/licenses/ http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions. 1. Definitions.
"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. "Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: 4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices stating that You changed the files; and (b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. (d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. 9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work. APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright 2025 baldnerd Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0 http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS, distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and See the License for the specific language governing permissions and
limitations under the License. limitations under the License.

158
README.md
View File

@ -1,3 +1,157 @@
# gitGK # gitGK Git Appliance
gitGK is a completely self-contained git server with no cloud dependency. It's also private and secure... your code never leaves your system. Whether you're developing software, maintaining configs, or tracking changes to any file-based workflow, gitGK is the cleanest, most efficient way to bring Git versioning in-house. ![gitGK Logo](./img/gitGK.svg)
**gitGK** is a completely self-contained git server with no cloud dependency. It's also private and secure... your code never leaves your system. Whether you're developing software, maintaining configs, or tracking changes to any file-based workflow, gitGK is the cleanest, most efficient way to bring Git versioning in-house.
Based on Gitea and pre-configured to run on Debian Linux, gitGK was created by Robbie Ferguson at **Category5 TV Network** to provide a fast, open-source alternative to GitHub and GitLab with full control and zero vendor lock-in.
---
## 🚀 Features
- Fully automated install in minutes
- Secure-by-default configuration
- Gitea web UI (GitHub-style)
- MariaDB database backend
- NGINX reverse proxy
- Optional HTTPS via Let's Encrypt
- Automatic security updates enabled
---
## 🛠️ Installation
### Step 1: Download the Installer
```bash
wget https://raw.githubusercontent.com/Cat5TV/gitGK/refs/heads/main/install-gitgk.sh
chmod +x install-gitgk.sh
```
### Step 2: Run it
With a domain name:
```bash
sudo ./install-gitgk.sh git.example.com
```
Or just use your server's IP:
```bash
sudo ./install-gitgk.sh
```
This will install:
- Git
- Gitea (latest release)
- MariaDB
- NGINX (preconfigured for secure web UI access)
- Automatic security updates
It will also:
- Create system users
- Set up services with `systemd`
- Launch the Gitea web UI (default port: 3000 or as configured)
---
## 📂 Post-Install Info
- Web UI: Visit `http://yourdomain` or `http://your-server-ip`
- Admin account setup is completed via the browser
- MariaDB password saved to: `/root/gitea-db-password.txt`
- Repo data stored in: `/var/lib/gitea`
- Configuration in: `/etc/gitea/`
---
## 🔀 Step 3 (Optional): Move gitGK Data to External Disk
You can move all persistent gitGK data (repos + database) to a mounted external volume, such as a second VHD.
This step is for advanced users only, and the following commands are only examples.
### Step-by-step:
1. Mount your external storage to a path like `/mnt/gitgk-data`:
```bash
sudo mount /dev/sdb1 /mnt/gitgk-data
```
2. Run the migration script:
```bash
wget https://raw.githubusercontent.com/Cat5TV/gitGK/refs/heads/main/gitgk-datamove.sh
chmod +x gitgk-datamove.sh
sudo ./gitgk-datamove.sh /mnt/gitgk-data
```
This will:
- Stop services
- Move Gitea data and MariaDB data to the mounted volume
- Update the MariaDB config
- Replace original data folders with symlinks
- Restart services
⚠️ **IMPORTANT**
You must add the mount to `/etc/fstab` to ensure it is mounted again after reboot.
Failing to do so will prevent gitGK from starting after a reboot.
Example `/etc/fstab` entry:
```
/dev/sdb1 /mnt/gitgk-data ext4 defaults 0 2
```
---
## 🛡️ Security
- Unattended security updates are **enabled**
- MariaDB runs with a strong root password (generated during install)
- Gitea runs under a limited system user
- All services are managed with `systemd`
- A firewall is recommended (not configured by default)
- Automatic security updates are enabled
---
## 🔄 Backups
You can include this server in your existing `rdiff-backup` or snapshot routines.
Make sure to include:
- `/var/lib/gitea` (or your mounted data location)
- `/var/lib/mysql` (or your mounted data location)
- `/etc/gitea/` and `/etc/mysql/`
---
---
## 🌐 Update Host IP or Use a Domain
If you're deploying a pre-built image, or the IP of your gitGK server otherwise changes (such as when cloning a VM), or if you want to use a domain instead of an IP address, use the included utility script:
```bash
wget https://raw.githubusercontent.com/Cat5TV/gitGK/refs/heads/main/gitgk-host.sh
chmod +x gitgk-host.sh
sudo ./gitgk-host.sh
```
This script:
- Detects and replaces the old IP or hostname in both:
- `/etc/gitea/app.ini`
- `/etc/nginx/sites-available/gitea`
- Allows you to enter a domain name instead of using an IP
- Automatically restarts Gitea and reloads NGINX
This is especially useful if your VM gets a new IP or if you bind your gitGK appliance to DNS.
## 📜 License
Licensed under the **Apache License 2.0**
(c) 2025 Robbie Ferguson
**Category5 TV Network**

106
gitgk-datamove.sh Executable file
View File

@ -0,0 +1,106 @@
#!/bin/bash
# gitgk-datamove.sh - Moves Gitea and MariaDB data to mounted external storage (e.g., VHD)
#
# Copyright 2025 Robbie Ferguson
# Category5 TV Network
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
set -e
# === Configurable Variables ===
TARGET_BASE="${1}"
if [[ -z "$TARGET_BASE" ]] || [[ ! -d "$TARGET_BASE" ]]; then
echo "Usage: sudo ./gitgk-datamove.sh /mnt/your-mounted-disk"
echo ""
echo "This script will move all gitGK data to the given target directory."
echo "Make sure the disk is mounted first. Example:"
echo ""
echo " sudo mount /dev/sdb1 /mnt/gitgk-data"
echo ""
echo "Then run:"
echo " sudo ./gitgk-datamove.sh /mnt/gitgk-data"
echo ""
echo "IMPORTANT: If you reboot your system without mounting this path again,"
echo " gitGK will FAIL TO START. You must add an fstab entry first."
echo ""
echo "Example fstab entry:"
echo " /dev/sdX1 /mnt/gitgk-data ext4 defaults 0 2"
echo ""
exit 1
fi
GITEA_SRC="/var/lib/gitea/data"
MYSQL_SRC="/var/lib/mysql"
GITEA_DEST="$TARGET_BASE/data"
MYSQL_DEST="$TARGET_BASE/mysql"
MYSQL_CONFIG="/etc/mysql/mariadb.conf.d/50-server.cnf"
# Ensure root
if [[ $EUID -ne 0 ]]; then
echo "This script must be run as root."
exit 1
fi
# === Determine what to move ===
echo ""
read -p "Would you like to move Gitea repository data to $TARGET_BASE? [y/N]: " MOVE_GITEA
read -p "Would you like to move MariaDB database data to $TARGET_BASE? [y/N]: " MOVE_MYSQL
echo "Stopping services..."
systemctl stop gitea || true
systemctl stop mariadb || true
# === Gitea Data ===
if [[ "$MOVE_GITEA" =~ ^[Yy]$ ]]; then
if mountpoint -q "$GITEA_SRC" || df "$GITEA_SRC" | grep -q "$TARGET_BASE"; then
echo "Gitea data already resides on the target mount. Skipping Gitea move."
else
echo "Moving Gitea data to $GITEA_DEST"
mkdir -p "$GITEA_DEST"
rsync -av "$GITEA_SRC/" "$GITEA_DEST/"
chown -R gitea:gitea "$GITEA_DEST"
mv "$GITEA_SRC" "${GITEA_SRC}.bak"
ln -s "$GITEA_DEST" "$GITEA_SRC"
fi
else
echo "Skipping Gitea data move."
fi
# === MariaDB Data ===
if [[ "$MOVE_MYSQL" =~ ^[Yy]$ ]]; then
echo "Moving MariaDB data to $MYSQL_DEST"
mkdir -p "$MYSQL_DEST"
rsync -av "$MYSQL_SRC/" "$MYSQL_DEST/"
chown -R mysql:mysql "$MYSQL_DEST"
cp "$MYSQL_CONFIG" "$MYSQL_CONFIG.bak"
sed -i "s|^datadir\s*=.*|datadir = $MYSQL_DEST|" "$MYSQL_CONFIG"
mv "$MYSQL_SRC" "${MYSQL_SRC}.bak"
ln -s "$MYSQL_DEST" "$MYSQL_SRC"
else
echo "Skipping MariaDB data move."
fi
# === Restart services ===
echo "Starting services..."
systemctl start mariadb
systemctl start gitea
echo ""
echo "Selected gitGK data has been moved to $TARGET_BASE (if requested)"
echo "IMPORTANT: Ensure this mount is present before reboot or services may fail."
echo "Example fstab line:"
echo " /dev/sdX1 $TARGET_BASE ext4 defaults 0 2"

60
gitgk-host.sh Executable file
View File

@ -0,0 +1,60 @@
#!/bin/bash
# gitgk-host.sh - Fixes hardcoded IPs in gitGK configs after IP change or domain assignment
#
# Copyright 2025 Robbie Ferguson
# Category5 TV Network
#
# Licensed under the Apache License, Version 2.0
set -e
GITEA_CONFIG="/etc/gitea/app.ini"
NGINX_CONFIG="/etc/nginx/sites-available/gitea"
# Ask user if they want to use a domain
read -p "Would you like to use a domain name instead of your IP? [y/N]: " USE_DOMAIN
if [[ "$USE_DOMAIN" =~ ^[Yy]$ ]]; then
read -p "Enter your domain name (e.g., git.example.com): " NEW_HOST
else
# Get the current IP address (first non-loopback)
NEW_HOST=$(hostname -I | awk '{print $1}')
if [[ -z "$NEW_HOST" ]]; then
echo "Unable to determine the current IP address."
exit 1
fi
fi
echo "New hostname to configure: $NEW_HOST"
# Check if the new host is already in use
if grep -q "$NEW_HOST" "$GITEA_CONFIG" && grep -q "$NEW_HOST" "$NGINX_CONFIG"; then
echo "Config files already use this host. No changes needed."
exit 0
fi
# Detect old IP or host in the config files (excluding loopback and localhost)
OLD_HOST=$(grep -Eo '([0-9]{1,3}\.){3}[0-9]{1,3}' "$GITEA_CONFIG" | grep -v '127.0.0.1' | head -n 1)
if [[ -z "$OLD_HOST" ]]; then
OLD_HOST=$(grep -Eo '([a-zA-Z0-9.-]+\.[a-zA-Z]{2,6})' "$GITEA_CONFIG" | grep -v 'localhost' | head -n 1)
fi
if [[ -z "$OLD_HOST" ]]; then
echo "Could not detect the current configured host."
read -p "Please enter the host (IP or domain) to replace: " OLD_HOST
fi
echo "Replacing $OLD_HOST with $NEW_HOST in config files..."
# Replace in Gitea app.ini
sed -i "s/$OLD_HOST/$NEW_HOST/g" "$GITEA_CONFIG"
# Replace in NGINX config
sed -i "s/$OLD_HOST/$NEW_HOST/g" "$NGINX_CONFIG"
# Restart services
echo "Restarting Gitea and NGINX..."
systemctl restart gitea
systemctl reload nginx
echo "Hostname/IP successfully updated to: $NEW_HOST"

9
img/gitGK.svg Executable file
View File

@ -0,0 +1,9 @@
<svg width="240" height="80" viewBox="0 0 240 80" xmlns="http://www.w3.org/2000/svg">
<style>
.git { fill: #1a1a1a; font-weight: bold; }
.gk { fill: #00cc66; font-weight: bold; }
text { font-family: 'Segoe UI', 'Arial', sans-serif; font-size: 64px; }
</style>
<text x="0" y="60" class="git">git</text>
<text x="100" y="60" class="gk">GK</text>
</svg>
Side by Side

After

Width:  |  Height:  |  Size: 372 B

165
install-gitgk.sh Executable file
View File

@ -0,0 +1,165 @@
#!/bin/bash
# install-gitgk.sh - Installer for gitGK Git Appliance
#
# Copyright 2025 Robbie Ferguson
# Category5 TV Network
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
set -e
# === Configuration ===
DOMAIN=${1:-} # Optional: pass domain as first argument
if [ -z "$DOMAIN" ]; then
DOMAIN=$(hostname -I | awk '{print $1}')
echo "No domain provided, using IP: $DOMAIN"
fi
GITEA_USER="gitea"
GITEA_DB="gitea"
GITEA_DB_USER="gitea"
GITEA_DB_PASS="$(openssl rand -base64 32)"
GITEA_VERSION="1.24.1"
# === Confirm root privileges ===
if [ "$(id -u)" -ne 0 ]; then
echo "Please run this script as root or with sudo."
exit 1
fi
echo "Updating system and installing required packages..."
apt update
DEBIAN_FRONTEND=noninteractive apt install -y \
git \
wget \
curl \
mariadb-server \
nginx \
certbot \
python3-certbot-nginx \
openssl \
unattended-upgrades \
apt-listchanges
echo "Enabling automatic security updates..."
dpkg-reconfigure -f noninteractive unattended-upgrades
# === Setup Gitea Users and Directories ===
echo "Creating system users..."
id git >/dev/null 2>&1 || adduser --system --group --home /home/git --shell /bin/bash git
id "$GITEA_USER" >/dev/null 2>&1 || adduser --system --group --home /home/gitea --shell /bin/bash "$GITEA_USER"
echo "Setting up gitGK directories..."
mkdir -p /var/lib/gitea/{custom,data,log}
mkdir -p /etc/gitea
chown -R $GITEA_USER:$GITEA_USER /var/lib/gitea
chown root:$GITEA_USER /etc/gitea
chmod -R 750 /var/lib/gitea
chmod 770 /etc/gitea
echo "Installing Gitea binary..."
echo "Downloading Gitea binary..."
GITEA_BINARY_URL="https://dl.gitea.com/gitea/1.24.1/gitea-${GITEA_VERSION}-linux-amd64"
wget -q --show-progress -O /usr/local/bin/gitea "$GITEA_BINARY_URL"
if [[ ! -x /usr/local/bin/gitea ]]; then
chmod +x /usr/local/bin/gitea
fi
if ! /usr/local/bin/gitea --version &>/dev/null; then
echo "Failed to install Gitea. Check your network connection or the URL."
exit 1
else
echo "Gitea installed: version $(/usr/local/bin/gitea --version)"
fi
echo "Creating Gitea systemd service..."
cat > /etc/systemd/system/gitea.service <<EOF
[Unit]
Description=Gitea (Git with a cup of tea)
After=network.target
[Service]
RestartSec=2s
Type=simple
User=$GITEA_USER
Group=$GITEA_USER
WorkingDirectory=/var/lib/gitea/
ExecStart=/usr/local/bin/gitea web --config /etc/gitea/app.ini
Restart=always
Environment=USER=$GITEA_USER HOME=/home/$GITEA_USER GITEA_WORK_DIR=/var/lib/gitea
[Install]
WantedBy=multi-user.target
EOF
echo "Starting Gitea service..."
systemctl daemon-reexec
systemctl enable --now gitea
# === MariaDB Setup ===
echo "Setting up MariaDB database..."
mysql -e "
CREATE DATABASE IF NOT EXISTS \`$GITEA_DB\` CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
CREATE USER IF NOT EXISTS '$GITEA_DB_USER'@'localhost' IDENTIFIED BY '$GITEA_DB_PASS';
GRANT ALL PRIVILEGES ON \`$GITEA_DB\`.* TO '$GITEA_DB_USER'@'localhost';
FLUSH PRIVILEGES;"
echo "$GITEA_DB_PASS" > /root/gitea-db-password.txt
chmod 600 /root/gitea-db-password.txt
echo "MariaDB credentials saved to /root/gitea-db-password.txt"
# === NGINX Reverse Proxy Setup ===
echo "Configuring NGINX reverse proxy..."
cat > /etc/nginx/sites-available/gitea <<EOF
server {
listen 80;
server_name $DOMAIN;
location / {
proxy_pass http://127.0.0.1:3000;
proxy_set_header Host \$host;
proxy_set_header X-Real-IP \$remote_addr;
proxy_set_header X-Forwarded-For \$proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Proto \$scheme;
}
}
EOF
ln -sf /etc/nginx/sites-available/gitea /etc/nginx/sites-enabled/gitea
nginx -t && systemctl reload nginx
# === Let's Encrypt Setup (optional, only for FQDN) ===
if [[ "$DOMAIN" != *[0-9]* ]]; then
echo "Attempting HTTPS setup with Let's Encrypt for domain: $DOMAIN"
certbot --non-interactive --nginx --agree-tos -d "$DOMAIN" -m admin@"$DOMAIN" || echo "Certbot failed; skipping SSL"
else
echo "Domain appears to be an IP address. Skipping SSL certificate setup."
fi
# === Final Notes ===
echo ""
echo "======================================================="
echo "gitGK Git Appliance Installed Successfully"
echo ""
echo "Web UI: http://$DOMAIN"
echo "Repo Path: /var/lib/gitea"
echo "MariaDB: User '$GITEA_DB_USER', database '$GITEA_DB'"
echo "Credentials saved to: /root/gitea-db-password.txt"
echo "Auto Security Updates: ENABLED"
echo ""
echo "Next Steps:"
echo "- Visit the web interface to complete the admin setup."
echo "- Consider configuring HTTPS if you used an IP."
echo "- Schedule backups of /etc/gitea, /var/lib/gitea, and the DB."
echo "======================================================="