commit 2337c0d21f3b8b01fa725036a345b07221e724e8 Author: Odyssium Date: Mon Apr 3 13:53:26 2023 +0200 Initial commit Signed-off-by: Odyssium diff --git a/.woodpecker.yml b/.woodpecker.yml new file mode 100644 index 0000000..8e1a42f --- /dev/null +++ b/.woodpecker.yml @@ -0,0 +1,25 @@ +pipeline: + build: + image: squidfunk/mkdocs-material + commands: + - mkdocs build + deploy: + image: opensuse/tumbleweed + secrets: [ ssh_key, mail ] + commands: + - zypper in -y git openssh + # SSH configuration + - mkdir ~/.ssh + - ssh-keyscan -t ed25519 codeberg.org >> ~/.ssh/known_hosts + - eval `ssh-agent` + - echo "$SSH_KEY" | tr -d '\r' | ssh-add - + # Configure Git + - git config --global user.email $MAIL + - git config --global user.name "Woodpecker CI" + - git clone --depth 1 git@codeberg.org:gothub/pages.git + - cd pages + - rm -rf docs + - mv ../site docs + - git add . + - git commit -m "Update docs" + - git push \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..aa7acc7 --- /dev/null +++ b/LICENSE @@ -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 2023 [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/README.md b/README.md new file mode 100644 index 0000000..f031f58 --- /dev/null +++ b/README.md @@ -0,0 +1,5 @@ +# GotHub documentation + +Made with mkdocs and mkdocs-material. + +[link](https://gothub.app/docs) \ No newline at end of file diff --git a/docs/assets/logo.svg b/docs/assets/logo.svg new file mode 100644 index 0000000..9d07b03 --- /dev/null +++ b/docs/assets/logo.svg @@ -0,0 +1,150 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/environment_variables.md b/docs/environment_variables.md new file mode 100644 index 0000000..662761f --- /dev/null +++ b/docs/environment_variables.md @@ -0,0 +1,55 @@ +# Environment variables used by GotHub + +You can set these in two ways: + +1. Create a .env file in the root directory of GotHub and set the variables there. + +2. Set the variables in your environment. + +## Instance configuration + +### GOTHUB_SETUP_COMPLETE + +This variable is used by GotHub to check if you've completed setup or not. The GotHub setup wizard sets this to true for you. If it's empty, you will get a banner on GotHub's main page saying you haven't completed setup. Once you're done setting up GotHub, set this to true. + +### GOTHUB_IP_LOGGED + +If you log IPs on your instance, set this to true. Otherwise, set it to false. + +### GOTHUB_REQUEST_URL_LOGGED + +If you log request URLs on your instance, set this to true. Otherwise, set it to false. + +### GOTHUB_USER_AGENT_LOGGED + +If you log user agents on your instance, set this to true. Otherwise, set it to false. + +### GOTHUB_DIAGNOSTIC_INFO_LOGGED + +If you log diagnostic info on your instance, set this to true. Otherwise, set it to false. + +### GOTHUB_INSTANCE_PRIVACY_POLICY + +URL to your instance's privacy policy. Set to "" if you don't have one. For example: ``GOTHUB_INSTANCE_PRIVACY_POLICY=https://instance.dev/privacy-policy`` + +### GOTHUB_INSTANCE_COUNTRY + +Country where your instance is hosted. For example: ``GOTHUB_INSTANCE_COUNTRY=Norway`` + +### GOTHUB_INSTANCE_PROVIDER + +Name of your ISP/Hosting provider. For example: ``GOTHUB_INSTANCE_PROVIDER=Altibox`` + +### GOTHUB_INSTANCE_CLOUDFLARE + +If you're using Cloudflare, set this to true. Otherwise, set it to false. + +## GotHub server configuration + +### GOTHUB_PORT + +Port to run GotHub on. For example: ``GOTHUB_PORT=8080``. This gets overwritten by the "--port" flag if you pass it to the "gothub serve" command. Set to 3000 by default, optional. + +### GOTHUB_USER_AGENT + +User agent to use when making requests to GitHub. For example: ``GOTHUB_USER_AGENT=GotHub/1.0.0``. Set to Chrome on Windows 10 by default, optional. \ No newline at end of file diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..c48cc8b --- /dev/null +++ b/docs/index.md @@ -0,0 +1,6 @@ +# Home + +This is the documentation for GotHub, the free and open source alternative front-end for GitHub. It's mostly aimed towards developers and instance owners who want to self-host GotHub. + +[GotHub website](https://gothub.app){ .md-button .md-button--primary } +[GotHub repository](https://codeberg.org/gothub/gothub){ .md-button .md-button--primary } diff --git a/docs/setup_docker.md b/docs/setup_docker.md new file mode 100644 index 0000000..71fa259 --- /dev/null +++ b/docs/setup_docker.md @@ -0,0 +1,57 @@ +# Setup GotHub in a Docker container + +!!! note + + Installing an automatic container update tool alongside GotHub is highly recommended. We recommend Watchtower. + +## Requirements + +- Docker (duh) +- A web server (we recommend Caddy) + +## Run method + +!!! note + + We recommend you to use the Compose method mentioned below, because it's easier to maintain and update. + +Our Docker image is available on the Codeberg registry [here](https://codeberg.org/gothub/-/packages/container/gothub/dev). + +You can run GotHub in a Docker container by running the following command: + +```bash +docker run -d --name gothub -p 3000:3000 codeberg.org/gothub/gothub:dev +``` + +You can also run the ``master`` branch of GotHub by replacing ``dev`` with ``latest``. Confusing, right? + +!!! warning + + GotHub requires a couple of environment variables if you'd like to get listed on the instances list. We mention the most minimal command up there just in case someone wants to run GotHub locally. You can pass a .env file to the docker run command by adding ``--env-file .env`` to the command. + +## Compose method + +We have a compose.yml file available on our Codeberg repository. You can find it [here](https://codeberg.org/gothub/gothub/src/branch/dev/compose.yml). + +You can run GotHub in a Docker container by running the following command: + +```bash +mkdir gothub +cd gothub +wget https://codeberg.org/gothub/gothub/raw/branch/dev/compose.yml +docker compose up -d +``` + +!!! warning + + You should definitely edit the compose.yml file, as it contains a couple of environment variables you should fill out if you want to get listed on the instances list. + +### Keep GotHub up-to-date + +We recommend you get an automatic container update tool alongside GotHub. We recommend Watchtower for this. + +If you don't want to use Watchtower, you can update GotHub by running the following command: + +```bash +docker compose pull && docker compose down && docker compose up -d +``` \ No newline at end of file diff --git a/docs/setup_manual.md b/docs/setup_manual.md new file mode 100644 index 0000000..1bd8b16 --- /dev/null +++ b/docs/setup_manual.md @@ -0,0 +1,53 @@ +# Setup GotHub manually + +!!! note + + We recommend you to use Docker over manually running GotHub, because it's easier and you can have automatic updates via Watchtower. You can find the Docker documentation [here](/docs/setup_docker.md). If you still want to run GotHub manually, you can continue reading. + +## Requirements + +- Git +- Go 1.19 or higher +- A web server (we recommend Caddy) + +## Installation + +You need to clone the repository. You can do this by running the following command: + +```bash +git clone https://codeberg.org/gothub/gothub.git +``` + +Then, you need to build the binary. You can do this by running the following command: + +```bash +go build +``` + +## Configuration + +GotHub uses environment variables for configuration. You can find a list of all environment variables [here](/docs/environment_variables.md). + +GotHub has a setup wizard that will help you configure GotHub. Run the following command to start the setup wizard: + +```bash +./gothub setup +``` + +The wizard will ask you a few questions about your privacy practices, where you're hosting etc. After you've answered all the questions, the wizard will generate a ".env" file for you. You can then start GotHub by running the following command: + +```bash +./gothub serve +``` + +You can also pass ``--port`` to specify a port to run GotHub on. This overrides the GOTHUB_PORT environment variable. + +## Keep GotHub up-to-date + +GotHub's CLI has a command to update GotHub. You can run this command by running the following command: + +```bash +./gothub update +``` + +It will try to pull from Git and then rebuild the binary. If it doesn't work, just run ``git pull`` and then ``go build``. \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..128128f --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,22 @@ +site_name: GotHub documentation +site_description: Documentation for GotHub +site_author: The GotHub team + +repo_url: https://codeberg.org/gothub/gothub +repo_name: gothub/gothub + +theme: + logo: assets/logo.svg + favicon: assets/logo.svg + name: material + palette: + primary: black + accent: cyan + background: black + features: + - navigation.instant + - navigation.tracking + +markdown_extensions: + - admonition + - attr_list