GotHub/pages
1
0
Fork 0
mirror of https://codeberg.org/gothub/pages synced 2024-12-06 19:16:41 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity
Files
master
pages/docs/environment_variables/index.html
T
Woodpecker CI d292dfbda3 Update docs
2023-05-16 12:42:01 +00:00

676 lines
20 KiB
HTML
Raw Permalink Blame History

<!doctype html>
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<meta name="description" content="Documentation for GotHub">
<meta name="author" content="The GotHub team">
<link rel="prev" href="..">
<link rel="next" href="../setup_docker/">
<link rel="icon" href="../assets/logo.svg">
<meta name="generator" content="mkdocs-1.4.3, mkdocs-material-9.1.12">
<title>Environment variables used by GotHub - GotHub documentation</title>
<link rel="stylesheet" href="../assets/stylesheets/main.85bb2934.min.css">
<link rel="stylesheet" href="../assets/stylesheets/palette.a6bdf11c.min.css">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
</head>
<body dir="ltr" data-md-color-scheme="default" data-md-color-primary="black" data-md-color-accent="cyan">
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a href="#environment-variables-used-by-gothub" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
</div>
<header class="md-header md-header--shadow" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href=".." title="GotHub documentation" class="md-header__button md-logo" aria-label="GotHub documentation" data-md-component="logo">
<img src="../assets/logo.svg" alt="logo">
</a>
<label class="md-header__button md-icon" for="__drawer">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
</label>
<div class="md-header__title" data-md-component="header-title">
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
GotHub documentation
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
Environment variables used by GotHub
</span>
</div>
</div>
</div>
<label class="md-header__button md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
</label>
<div class="md-search" data-md-component="search" role="dialog">
<label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search">
<form class="md-search__form" name="search">
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
<label class="md-search__icon md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg>
</label>
<nav class="md-search__options" aria-label="Search">
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z"/></svg>
</button>
</nav>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" data-md-scrollfix>
<div class="md-search-result" data-md-component="search-result">
<div class="md-search-result__meta">
Initializing search
</div>
<ol class="md-search-result__list" role="presentation"></ol>
</div>
</div>
</div>
</div>
</div>
<div class="md-header__source">
<a href="https://codeberg.org/gothub/gothub" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.4.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
</div>
<div class="md-source__repository">
gothub/gothub
</div>
</a>
</div>
</nav>
</header>
<div class="md-container" data-md-component="container">
<main class="md-main" data-md-component="main">
<div class="md-main__inner md-grid">
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href=".." title="GotHub documentation" class="md-nav__button md-logo" aria-label="GotHub documentation" data-md-component="logo">
<img src="../assets/logo.svg" alt="logo">
</a>
GotHub documentation
</label>
<div class="md-nav__source">
<a href="https://codeberg.org/gothub/gothub" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.4.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
</div>
<div class="md-source__repository">
gothub/gothub
</div>
</a>
</div>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href=".." class="md-nav__link">
Home
</a>
</li>
<li class="md-nav__item md-nav__item--active">
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
<label class="md-nav__link md-nav__link--active" for="__toc">
Environment variables used by GotHub
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
Environment variables used by GotHub
</a>
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#instance-configuration" class="md-nav__link">
Instance configuration
</a>
<nav class="md-nav" aria-label="Instance configuration">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#gothub_setup_complete" class="md-nav__link">
GOTHUB_SETUP_COMPLETE
</a>
</li>
<li class="md-nav__item">
<a href="#gothub_proxying_enabled" class="md-nav__link">
GOTHUB_PROXYING_ENABLED
</a>
</li>
<li class="md-nav__item">
<a href="#gothub_ip_logged" class="md-nav__link">
GOTHUB_IP_LOGGED
</a>
</li>
<li class="md-nav__item">
<a href="#gothub_request_url_logged" class="md-nav__link">
GOTHUB_REQUEST_URL_LOGGED
</a>
</li>
<li class="md-nav__item">
<a href="#gothub_user_agent_logged" class="md-nav__link">
GOTHUB_USER_AGENT_LOGGED
</a>
</li>
<li class="md-nav__item">
<a href="#gothub_diagnostic_info_logged" class="md-nav__link">
GOTHUB_DIAGNOSTIC_INFO_LOGGED
</a>
</li>
<li class="md-nav__item">
<a href="#gothub_instance_privacy_policy" class="md-nav__link">
GOTHUB_INSTANCE_PRIVACY_POLICY
</a>
</li>
<li class="md-nav__item">
<a href="#gothub_instance_country" class="md-nav__link">
GOTHUB_INSTANCE_COUNTRY
</a>
</li>
<li class="md-nav__item">
<a href="#gothub_instance_provider" class="md-nav__link">
GOTHUB_INSTANCE_PROVIDER
</a>
</li>
<li class="md-nav__item">
<a href="#gothub_instance_cloudflare" class="md-nav__link">
GOTHUB_INSTANCE_CLOUDFLARE
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#gothub-server-configuration" class="md-nav__link">
GotHub server configuration
</a>
<nav class="md-nav" aria-label="GotHub server configuration">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#gothub_port" class="md-nav__link">
GOTHUB_PORT
</a>
</li>
<li class="md-nav__item">
<a href="#gothub_user_agent" class="md-nav__link">
GOTHUB_USER_AGENT
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../setup_docker/" class="md-nav__link">
Setup GotHub in a Docker container
</a>
</li>
<li class="md-nav__item">
<a href="../setup_manual/" class="md-nav__link">
Setup GotHub manually
</a>
</li>
<li class="md-nav__item">
<a href="../setup_caddy/" class="md-nav__link">
Setting up Caddy for GotHub
</a>
</li>
<li class="md-nav__item">
<a href="../setup_nginx/" class="md-nav__link">
Setting up NGINX for GotHub
</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#instance-configuration" class="md-nav__link">
Instance configuration
</a>
<nav class="md-nav" aria-label="Instance configuration">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#gothub_setup_complete" class="md-nav__link">
GOTHUB_SETUP_COMPLETE
</a>
</li>
<li class="md-nav__item">
<a href="#gothub_proxying_enabled" class="md-nav__link">
GOTHUB_PROXYING_ENABLED
</a>
</li>
<li class="md-nav__item">
<a href="#gothub_ip_logged" class="md-nav__link">
GOTHUB_IP_LOGGED
</a>
</li>
<li class="md-nav__item">
<a href="#gothub_request_url_logged" class="md-nav__link">
GOTHUB_REQUEST_URL_LOGGED
</a>
</li>
<li class="md-nav__item">
<a href="#gothub_user_agent_logged" class="md-nav__link">
GOTHUB_USER_AGENT_LOGGED
</a>
</li>
<li class="md-nav__item">
<a href="#gothub_diagnostic_info_logged" class="md-nav__link">
GOTHUB_DIAGNOSTIC_INFO_LOGGED
</a>
</li>
<li class="md-nav__item">
<a href="#gothub_instance_privacy_policy" class="md-nav__link">
GOTHUB_INSTANCE_PRIVACY_POLICY
</a>
</li>
<li class="md-nav__item">
<a href="#gothub_instance_country" class="md-nav__link">
GOTHUB_INSTANCE_COUNTRY
</a>
</li>
<li class="md-nav__item">
<a href="#gothub_instance_provider" class="md-nav__link">
GOTHUB_INSTANCE_PROVIDER
</a>
</li>
<li class="md-nav__item">
<a href="#gothub_instance_cloudflare" class="md-nav__link">
GOTHUB_INSTANCE_CLOUDFLARE
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#gothub-server-configuration" class="md-nav__link">
GotHub server configuration
</a>
<nav class="md-nav" aria-label="GotHub server configuration">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#gothub_port" class="md-nav__link">
GOTHUB_PORT
</a>
</li>
<li class="md-nav__item">
<a href="#gothub_user_agent" class="md-nav__link">
GOTHUB_USER_AGENT
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset">
<h1 id="environment-variables-used-by-gothub">Environment variables used by GotHub</h1>
<p>You can set these in two ways:</p>
<ol>
<li>
<p>Create a .env file in the root directory of GotHub and set the variables there.</p>
</li>
<li>
<p>Set the variables in your environment.</p>
</li>
</ol>
<h2 id="instance-configuration">Instance configuration</h2>
<h3 id="gothub_setup_complete">GOTHUB_SETUP_COMPLETE</h3>
<p>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.</p>
<h3 id="gothub_proxying_enabled">GOTHUB_PROXYING_ENABLED</h3>
<p>If you don't want to proxy non-essential things (ie. avatars, repo archives, raw files) through your instance, set this to false.</p>
<h3 id="gothub_ip_logged">GOTHUB_IP_LOGGED</h3>
<p>If you log IPs on your instance, set this to true. Otherwise, set it to false.</p>
<h3 id="gothub_request_url_logged">GOTHUB_REQUEST_URL_LOGGED</h3>
<p>If you log request URLs on your instance, set this to true. Otherwise, set it to false.</p>
<h3 id="gothub_user_agent_logged">GOTHUB_USER_AGENT_LOGGED</h3>
<p>If you log user agents on your instance, set this to true. Otherwise, set it to false.</p>
<h3 id="gothub_diagnostic_info_logged">GOTHUB_DIAGNOSTIC_INFO_LOGGED</h3>
<p>If you log diagnostic info on your instance, set this to true. Otherwise, set it to false.</p>
<h3 id="gothub_instance_privacy_policy">GOTHUB_INSTANCE_PRIVACY_POLICY</h3>
<p>URL to your instance's privacy policy. Set to "" if you don't have one. For example: <code>GOTHUB_INSTANCE_PRIVACY_POLICY=https://instance.dev/privacy-policy</code></p>
<h3 id="gothub_instance_country">GOTHUB_INSTANCE_COUNTRY</h3>
<p>Country where your instance is hosted. For example: <code>GOTHUB_INSTANCE_COUNTRY=Norway</code></p>
<h3 id="gothub_instance_provider">GOTHUB_INSTANCE_PROVIDER</h3>
<p>Name of your ISP/Hosting provider. For example: <code>GOTHUB_INSTANCE_PROVIDER=Altibox</code></p>
<h3 id="gothub_instance_cloudflare">GOTHUB_INSTANCE_CLOUDFLARE</h3>
<p>If you're using Cloudflare, set this to true. Otherwise, set it to false.</p>
<h2 id="gothub-server-configuration">GotHub server configuration</h2>
<h3 id="gothub_port">GOTHUB_PORT</h3>
<p>Port to run GotHub on. For example: <code>GOTHUB_PORT=8080</code>. This gets overwritten by the "--port" flag if you pass it to the "gothub serve" command. Set to 3000 by default, optional.</p>
<h3 id="gothub_user_agent">GOTHUB_USER_AGENT</h3>
<p>User agent to use when making requests to GitHub. For example: <code>GOTHUB_USER_AGENT=GotHub/1.0.0</code>. Set to Chrome on Windows 10 by default, optional.</p>
</article>
</div>
</div>
</main>
<footer class="md-footer">
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-copyright">
Made with
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
Material for MkDocs
</a>
</div>
</div>
</div>
</footer>
</div>
<div class="md-dialog" data-md-component="dialog">
<div class="md-dialog__inner md-typeset"></div>
</div>
<script id="__config" type="application/json">{"base": "..", "features": ["navigation.instant", "navigation.tracking"], "search": "../assets/javascripts/workers/search.208ed371.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
<script src="../assets/javascripts/bundle.c2be25ad.min.js"></script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink