init

7 files changed, 449 insertions, 0 deletions

diff --git a/Dockerfile b/Dockerfile
new file mode 100644
index 0000000..1ef8e06
--- /dev/null
+++ b/Dockerfile
@@ -0,0 +1,55 @@
+FROM nginx:1.19-alpine
+
+# CGit
+ARG CGIT_VERSION=1.2.3-r0
+ENV CGIT_VERSION=${CGIT_VERSION}
+ENV CGIT_TITLE="cgit"
+ENV CGIT_DESC="A fast web interface for Git"
+ENV CGIT_VROOT="/"
+ENV CGIT_SECTION_FROM_STARTPATH=0
+ENV CGIT_MAX_REPO_COUNT=50
+
+LABEL version="${CGIT_VERSION}" \
+    description="A fast web interface for Git." \
+    maintainer="Jose Quintana <joseluisq.net>"
+
+RUN set -eux \
+    && apk add --no-cache \
+        ca-certificates \
+        cgit=${CGIT_VERSION} \
+        fcgiwrap \
+        git \
+        highlight \
+        lua5.3-libs \
+        py3-markdown \
+        py3-pygments \
+        python3 \
+        spawn-fcgi \
+        tzdata \
+        xz \
+        zlib \
+    && rm -rf /var/cache/apk/* \
+    && rm -rf /tmp/* \
+    && true
+
+COPY conf/cgit.conf /tmp/cgitrc.tmpl
+COPY conf/default.conf /etc/nginx/conf.d/default.conf
+
+VOLUME [ "/srv/git", "/var/cache/cgit" ]
+
+CMD chown nginx:nginx /var/cache/cgit \
+    && chmod u+g /var/cache/cgit \
+    && envsubst < /tmp/cgitrc.tmpl > /etc/cgitrc \
+    && spawn-fcgi \
+        -u nginx -g nginx \
+        -s /var/run/fcgiwrap.sock \
+        -n -- /usr/bin/fcgiwrap \
+    & nginx -g "daemon off;"
+
+# Metadata
+LABEL org.opencontainers.image.vendor="Jose Quintana" \
+    org.opencontainers.image.url="https://github.com/joseluisq/alpine-cgit" \
+    org.opencontainers.image.title="cgit" \
+    org.opencontainers.image.description="A fast web interface for git." \
+    org.opencontainers.image.version="${SERVER_VERSION}" \
+    org.opencontainers.image.documentation="https://github.com/joseluisq/alpine-cgit"
diff --git a/LICENSE-APACHE b/LICENSE-APACHE
new file mode 100644
index 0000000..16fe87b
--- /dev/null
+++ b/LICENSE-APACHE
@@ -0,0 +1,201 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "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.
+
+   "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.
+
+   "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.
+
+   "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.
+
+   "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.
+
+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.
+
+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
+
+   (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
+
+   (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.
+
+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.
+
+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.
+
+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
+
+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.
+
+Copyright [yyyy] [name of copyright owner]
+
+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.
diff --git a/LICENSE-MIT b/LICENSE-MIT
new file mode 100644
index 0000000..0e60829
--- /dev/null
+++ b/LICENSE-MIT
@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2019-present Jose Quintana <https://git.io/joseluisq>
+
+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.
diff --git a/Makefile b/Makefile
new file mode 100644
index 0000000..f9a12fe
--- /dev/null
+++ b/Makefile
@@ -0,0 +1,5 @@
+build:
+	docker build \
+		-t joseluisq/alpine-cgit:latest \
+		-f Dockerfile .
+.PHONY: build
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..359f326
--- /dev/null
+++ b/README.md
@@ -0,0 +1,65 @@
+# Alpine CGit
+
+> The hyperfast web frontend for [Git](https://git-scm.com/) repositories on top of [Alpine](https://alpinelinux.org/) + [Nginx](https://nginx.org/).
+
+[CGit](https://git.zx2c4.com/cgit/about/) is a web interface ([cgi](https://tools.ietf.org/html/rfc3875)) for [Git](https://git-scm.com/) repositories, written in C.
+
+## CGit features
+
+- Basic repository browsing (logs, diffs, trees...).
+- Caching of generated HTML.
+- Cloneable URLs (implements dumb HTTP transport).
+- Commit feeds (atom format).
+- Discovery of Git repositories.
+- On-the-fly archives for tags and commits.
+- Plugin support for e.g. syntax highlighting.
+- Side-by-side diffs.
+- Simple time/author statistics.
+- Simple virtual hosting support (macro expansion).
+- Understands GitWeb project-lists.
+- Understands gitweb.owner in Git config files.
+- Has extensive filtering framework using scripts or a built-in lua interpreter.
+
+For more details see [CGit project](https://git.zx2c4.com/cgit/about/).
+
+## Usage
+
+```sh
+docker run --rm -it \
+    -p 8787:80 \
+    -v /my/repos/:/srv/git/ \
+        joseluisq/alpine-cgit
+```
+
+**Dockerfile**
+
+```Dockerfile
+FROM joseluisq/alpine-cgit
+```
+
+## Volumes
+
+- `/srv/git`: Place for Git repositories.
+- `/var/cache/cgit`: CGit caching of generated HTML.
+
+## Settings via env variables
+
+- `CGIT_TITLE`: Website title.
+- `CGIT_DESC`: Website description.
+- `CGIT_VROOT`: Virtual root directory.
+- `CGIT_SECTION_FROM_STARTPATH`: How many path elements from each repo path to use as a default section name.
+- `CGIT_MAX_REPO_COUNT`: Number of entries to list per page on the repository index page.
+
+See default file configuration at [conf/cgit.conf](./conf/cgit.conf)
+
+## Contributions
+
+Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in current work by you, as defined in the Apache-2.0 license, shall be dual licensed as described below, without any additional terms or conditions.
+
+Feel free to send some [Pull request](https://github.com/joseluisq/rust-linux-darwin-builder/pulls) or [issue](https://github.com/joseluisq/rust-linux-darwin-builder/issues).
+
+## License
+
+This work is primarily distributed under the terms of both the [MIT license](LICENSE-MIT) and the [Apache License (Version 2.0)](LICENSE-APACHE).
+
+© 2021 [Jose Quintana](https://git.io/joseluisq)
diff --git a/conf/cgit.conf b/conf/cgit.conf
new file mode 100644
index 0000000..db9e4da
--- /dev/null
+++ b/conf/cgit.conf
@@ -0,0 +1,67 @@
+# CGit config file (cgitrc)
+# For all supported settings see https://linux.die.net/man/5/cgitrc
+
+root-title=$CGIT_TITLE
+root-desc=$CGIT_DESC
+
+source-filter=/usr/lib/cgit/filters/syntax-highlighting.py
+about-filter=/usr/lib/cgit/filters/about-formatting.sh
+
+##
+## Search for these files in the root of the default branch of repositories
+## for coming up with the about page:
+##
+readme=:README.md
+readme=:readme.md
+readme=:README.mkd
+readme=:readme.mkd
+readme=:README.rst
+readme=:readme.rst
+readme=:README.html
+readme=:readme.html
+readme=:README.htm
+readme=:readme.htm
+readme=:README.txt
+readme=:readme.txt
+readme=:README
+readme=:readme
+readme=:INSTALL.md
+readme=:install.md
+readme=:INSTALL.mkd
+readme=:install.mkd
+readme=:INSTALL.rst
+readme=:install.rst
+readme=:INSTALL.html
+readme=:install.html
+readme=:INSTALL.htm
+readme=:install.htm
+readme=:INSTALL.txt
+readme=:install.txt
+readme=:INSTALL
+readme=:install
+
+# Default Theme
+css=/cgit.css
+logo=/cgit.png
+
+# Cache
+cache-root=/var/cache/cgit
+cache-size=1000
+
+enable-index-links=1
+enable-index-owner=0
+enable-remote-branches=1
+enable-log-filecount=1
+enable-log-linecount=1
+enable-git-config=1
+snapshots=tar.xz zip
+
+robots=noindex, nofollow
+
+virtual-root=$CGIT_VROOT
+
+section-from-path=$CGIT_SECTION_FROM_STARTPATH
+
+max-repo-count=$CGIT_MAX_REPO_COUNT
+
+scan-path=/srv/git
diff --git a/conf/default.conf b/conf/default.conf
new file mode 100644
index 0000000..fe5c9ad
--- /dev/null
+++ b/conf/default.conf
@@ -0,0 +1,36 @@
+server {
+    listen          80;
+    server_name     localhost;
+    root            /usr/share/webapps/cgit;
+
+    location / {
+        try_files $uri @cgit;
+    }
+
+    location ~* ^.+(cgit.(css|png)|favicon.ico|robots.txt) {
+        root /usr/share/webapps/cgit;
+        expires 30d;
+    }
+
+    location @cgit {
+        gzip off;
+        include             /etc/nginx/fastcgi_params;
+        fastcgi_param       SCRIPT_FILENAME $document_root/cgit.cgi;
+        fastcgi_param       PATH_INFO       $uri;
+        fastcgi_param       QUERY_STRING    $args;
+        fastcgi_param       HTTP_HOST       $server_name;
+        fastcgi_pass        unix:/var/run/fcgiwrap.sock;
+    }
+
+    error_page  404         /404.html;
+    error_page  401         /401.html;
+
+    error_page  500 502 503 504  /50x.html;
+    location = /50x.html {
+        root   /usr/share/nginx/html;
+    }
+
+    location ~ /\.ht {
+        deny  all;
+    }
+}