diff --git a/.dockerfiles/entrypoint.sh b/.dockerfiles/entrypoint.sh index 93f4e47..3b35edc 100755 --- a/.dockerfiles/entrypoint.sh +++ b/.dockerfiles/entrypoint.sh @@ -8,21 +8,6 @@ if [ "$(id -u)" -eq 0 ]; then fi printf "Configuring application...\n" -cat > /Caddyfile <=1.18.0' + - name: Build Binary + run: make build diff --git a/Dockerfile b/Dockerfile index 2c6c78f..77dc65a 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,7 +1,18 @@ -FROM caddy:2.6-builder-alpine AS builder +# Build +FROM golang:alpine AS build + +RUN apk add --no-cache -U build-base git make + +RUN mkdir -p /src WORKDIR /src +# Copy Makefile +COPY Makefile ./ + +# Install deps +RUN make deps + # Copy go.mod and go.sum and install and cache dependencies COPY go.mod . COPY go.sum . @@ -10,12 +21,22 @@ COPY go.sum . COPY *.go ./ COPY ./gitea/*.go ./gitea/ -RUN go build . +# Version/Commit (there there is no .git in Docker build context) +# NOTE: This is fairly low down in the Dockerfile instructions so +# we don't break the Docker build cache just be changing +# unrelated files that actually haven't changed but caused the +# COMMIT value to change. +ARG VERSION="0.0.0" +ARG COMMIT="HEAD" +ARG BUILD="" + +# Build server binary +RUN make server VERSION=$VERSION COMMIT=$COMMIT BUILD=$BUILD # Runtime FROM alpine:latest -RUN apk --no-cache -U add su-exec shadow tzdata ca-certificates +RUN apk --no-cache -U add ca-certificates tzdata ENV PUID=1000 ENV PGID=1000 @@ -26,12 +47,11 @@ EXPOSE 8000/tcp VOLUME /data -WORKDIR /data +WORKDIR / -COPY --from=builder /src/pages-server /usr/local/bin/pages-server +# force cgo resolver +ENV GODEBUG=netdns=cgo -COPY .dockerfiles/entrypoint.sh /init +COPY --from=build /src/pages-server /usr/local/bin/pages-server -ENTRYPOINT ["/init"] - -CMD ["pages-server"] +CMD ["pages-server"] \ No newline at end of file diff --git a/LICENSE b/LICENSE index 261eeb9..db187b3 100644 --- a/LICENSE +++ b/LICENSE @@ -1,201 +1,24 @@ - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ +MIT License - TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION +Copyright (C) 2023-present James Mills - 1. Definitions. +pages-server is covered by the MIT license:: - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. +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: - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. +The above copyright notice and this permission notice shall be included +in all copies or substantial portions of the Software. - "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. +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 index 51dfb1d..01e55d7 100644 --- a/Makefile +++ b/Makefile @@ -1,6 +1,13 @@ -include environ.inc +export CGO_ENABLED=0 +VERSION ?= $(shell git describe --abbrev=0 --tags 2>/dev/null) +COMMIT ?= $(shell git rev-parse --short HEAD) BRANCH ?= $(shell git rev-parse --abbrev-ref HEAD) +BUILD ?= $(shell git show -s --pretty=format:%cI) +GOCMD=go + +DESTDIR=/usr/local/bin ifeq ($(LOCAL), 1) IMAGE := r.mills.io/prologic/pages-server @@ -15,28 +22,66 @@ TAG := dev endif endif +ifndef $$VERSION +VERSION := "0.0.0" +endif + all: help .PHONY: help help: ## Show this help message + @echo "pages-server - a Self-Hosted Pages Server for Gitea" @awk 'BEGIN {FS = ":.*##"; printf "\nUsage:\n make \033[36m\033[0m\n"} /^[$$()% a-zA-Z_-]+:.*?##/ { printf " \033[36m%-15s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST) +.PHONY: dev +dev : DEBUG=1 +dev : build ## Build debug version of pages-server (server) + @./pages-server -D + +.PHONY: build +build: ## Build the pages-server binary (server) +ifeq ($(DEBUG), 1) + @echo "Building in debug mode..." + @$(GOCMD) build $(FLAGS) -tags "netgo static_build" -installsuffix netgo \ + . +else + @$(GOCMD) build $(FLAGS) -tags "netgo static_build" -installsuffix netgo \ + . +endif + +.PHONY: install +install: build ## Install pages-server (server) to $DESTDIR + @install -D -m 755 pages-server $(DESTDIR)/pages-server + ifeq ($(PUBLISH), 1) .PHONY: image -image: ## Build the Docker image +image: generate ## Build the Docker image @docker buildx build \ --platform linux/amd64,linux/arm64 --push -t $(IMAGE):$(TAG) . else .PHONY: image -image: +image: generate @docker build \ -t $(IMAGE):$(TAG) . endif +.PHONY: fmt +fmt: ## Format sources files + @$(GOCMD) fmt ./... + +.PHONY: test +test: ## Run test suite + @CGO_ENABLED=1 $(GOCMD) test -v -cover -race ./... + +.PHONY: coverage +coverage: ## Get test coverage report + @CGO_ENABLED=1 $(GOCMD) test -v -cover -race -cover -coverprofile=coverage.out ./... + @$(GOCMD) tool cover -html=coverage.out + .PHONY: clean -clean: ## Remove untracked files (excluding Git ignored files) - @git clean -f -d +clean: ## Remove untracked files + @git clean -f -d -x .PHONY: clean-all clean-all: ## Remove untracked and Git ignored files - @git clean -f -d -s + @git clean -f -d -X diff --git a/README.md b/README.md index ebff4fc..cb6d74a 100644 --- a/README.md +++ b/README.md @@ -4,14 +4,16 @@ Currently supports the following: -- Proxies *.pages.mills.io -- Option 1: Repo with gitea-pages branch + gitea-pages topic => https://.pages.mills.io// -- Option 2: Repo of the form .pages.mills.io with gitea-pages branch and gitea-pages topic => https://.pages.mills.io +- Proxies `*.pages.` +- Option 1: Repo with gitea-pages branch + `gitea-pages` topic => `https://.//` +- Option 2: Repo of the form `.pages.` with `gitea-pages` branch and gitea-pages topic => `https://.` + +Where `` is the domain name and instance of your Gitea Pages server. Demo sites: -- https://actions.pages.mills.io/ -- https://prologic.pages.mills.io/test/ +- https://prologic.pages.mills.io/test/ serviced from https://git.mills.io/prologic/test (Option 1) +- https://actions.pages.mills.io/ serviced from https://git.mills.io/actions/actions.pages.mills.io (Option 2) ## Quick Start @@ -20,11 +22,11 @@ TBD ## Features - Proxies `./` => `owner/repo` -- Proxies `` => `owner/subdomain` +- Proxies `.` => `owner/subdomain` - Automatically sets MIME types on served content. - Ues `gitea-pages` as an "opt-in" topic label on repos. - Content is served from a `gitea-pages` branch. ## License -TBD +`pages-server` is licensed under the terms of the [MIT License](./LICENSE). \ No newline at end of file diff --git a/docker-stack.yml b/docker-stack.yml new file mode 100644 index 0000000..cfcec45 --- /dev/null +++ b/docker-stack.yml @@ -0,0 +1,32 @@ +--- +version: "3.8" + +services: + server: + image: prologic/pages-server:latest + environment: + - DOMAIN=${DOMAIN:?not set} + - GITEA_URL=${GITEA_URL:?not set} + - GITEA_TOKEN=${GITEA_TOKEN:?not set} + networks: + - traefik + deploy: + replicas: 1 + labels: + - traefik.enable=true + - traefik.docker.network=traefik + - traefik.http.services.pages.loadbalancer.server.port=8000 + - traefik.http.routers.pages.rule=HostRegexp(`{subdomain:.+}.${DOMAIN:?not set}`) + - traefik.http.routers.pages.priority=2 + resources: + reservations: + cpus: "0.1" + memory: 64M + limits: + memory: 128M + restart_policy: + condition: any + +networks: + traefik: + external: true diff --git a/main.go b/main.go index eb4e0c5..67fc536 100644 --- a/main.go +++ b/main.go @@ -1,4 +1,4 @@ -// Package main ... +// Package main implements a simple Gitea Pages server for hosting static websites. package main import (