mirror of
https://github.com/gogs/gogs.git
synced 2026-05-06 18:15:28 +02:00
docs: migrate to Mintlify (#8154)
This commit is contained in:
ᴊᴏᴇ ᴄʜᴇɴ
GitHub
77
docs/getting-started/installation.mdx
Normal file
77
docs/getting-started/installation.mdx
Normal file
@@ -0,0 +1,77 @@
|
||||
---
|
||||
title: "Installation"
|
||||
description: "Get your own Git service up and running in minutes"
|
||||
icon: "download"
|
||||
---
|
||||
|
||||
## Prerequisites
|
||||
|
||||
1. Gogs requires use of one of the following database backends:
|
||||
- MySQL, >= 5.7
|
||||
- PostgreSQL, >= 9.6
|
||||
- SQLite 3
|
||||
1. Git, >= 1.8.3, on both server and client side
|
||||
1. SSH server
|
||||
- Only required when enable Git over SSH, e.g., `git clone git@gogs.example.com:...`
|
||||
- Builtin SSH server is also available
|
||||
|
||||
<Note>
|
||||
**For Windows users:**
|
||||
|
||||
- When using builtin SSH server, you still need to have `ssh-keygen` installed and available via the `%PATH%` environment variable.
|
||||
- Use [OpenSSH](https://learn.microsoft.com/en-us/windows-server/administration/openssh/openssh_install_firstuse) on Windows 10 or newer.
|
||||
- [Cygwin OpenSSH](http://docs.oracle.com/cd/E24628_01/install.121/e22624/preinstall_req_cygwin_ssh.htm) or [Copssh](https://www.itefix.net/copssh) are available on older versions of Windows.
|
||||
</Note>
|
||||
|
||||
## Initialize database
|
||||
|
||||
If you choose to use MySQL or PostgreSQL as your database backend, you need to first complete the initial database creation.
|
||||
|
||||
<Tabs>
|
||||
<Tab title="PostgreSQL">
|
||||
Create a database user and database:
|
||||
|
||||
```bash
|
||||
psql -c "CREATE USER gogs WITH PASSWORD '{YOUR_PASSWORD}';"
|
||||
psql -c "CREATE DATABASE gogs OWNER gogs ENCODING 'UTF8';"
|
||||
```
|
||||
</Tab>
|
||||
<Tab title="MySQL">
|
||||
Use the [bundled script](https://github.com/gogs/gogs/blob/main/scripts/mysql.sql) to create the database with proper encoding:
|
||||
|
||||
```zsh
|
||||
mysql -u root -p < scripts/mysql.sql
|
||||
```
|
||||
</Tab>
|
||||
</Tabs>
|
||||
|
||||
## Installation methods
|
||||
|
||||
<Tabs>
|
||||
<Tab title="Pre-built binary">
|
||||
All release archives containing pre-built binaries are available in [dl.gogs.io](https://dl.gogs.io) and [GitHub releases](https://github.com/gogs/gogs/releases).
|
||||
|
||||
<Note>
|
||||
**For Windows users:**
|
||||
|
||||
Release archives containing `mws` come with built-in Windows service support. If you prefer to manage the service using [NSSM](https://nssm.cc), download the standard version instead.
|
||||
</Note>
|
||||
|
||||
Once extracted the archive, run `./gogs web` to start the server. Use `./gogs web --help` to see all available options.
|
||||
</Tab>
|
||||
<Tab title="Docker">
|
||||
Two types of Docker images are provided:
|
||||
1. [docker-next](https://github.com/gogs/gogs/blob/main/docker-next/README.md): The modern, non-root, and cloud-native version, but with no container options.
|
||||
1. [docker](https://github.com/gogs/gogs/blob/main/docker/README.md): The traditional, root-privileged version, with extensive container options.
|
||||
</Tab>
|
||||
<Tab title="Packages">
|
||||
<Warning>
|
||||
All packages listed below are packaged by third-party maintainers. Use at your own risk.
|
||||
</Warning>
|
||||
|
||||
|Source| Description | Note|
|
||||
|------|------------------------------------------|-----|
|
||||
|Packager.io ([link](https://packager.io/gh/gogs/gogs))|Every commit of `main`|After installation, place custom configuration in `/etc/default/gogs`.|
|
||||
|Arch User Repository ([link](https://aur.archlinux.org/packages/gogs/))| Stable releases | Detailed instructions available in the [Arch Linux Wiki entry](https://wiki.archlinux.org/title/Gogs). |
|
||||
</Tab>
|
||||
</Tabs>
|
||||
128
docs/getting-started/introduction.mdx
Normal file
128
docs/getting-started/introduction.mdx
Normal file
@@ -0,0 +1,128 @@
|
||||
---
|
||||
title: "Introduction"
|
||||
sidebarTitle: "Introduction"
|
||||
description: "The painless way to host your own Git service"
|
||||
icon: "book-open"
|
||||
---
|
||||
|
||||
<img
|
||||
className="block dark:hidden"
|
||||
src="/images/logo-light.svg"
|
||||
noZoom
|
||||
/>
|
||||
|
||||
<img
|
||||
className="hidden dark:block"
|
||||
src="/images/logo-dark.svg"
|
||||
noZoom
|
||||
/>
|
||||
|
||||
## Vision
|
||||
|
||||
The Gogs project aims to build a simple, stable and extensible self-hosted Git service that can be set up in the most painless way. With Go, this can be done with an independent binary distribution across all platforms that Go supports, including Linux, macOS, Windows and ARM-based systems.
|
||||
|
||||
## Core values
|
||||
|
||||
- **Simple to install**: Run the binary, or run as a Docker container.
|
||||
- **Cross-platform**: Runs on every platform that Go toolchain supports.
|
||||
- **Lightweight**: Unrealistically low resource consumption to get started. Only got 64 MiB of RAM and a quarter of vCPU? No problem!
|
||||
- **Open source**: MIT-licensed since 2014, all source code available in public.
|
||||
|
||||
## Sponsors
|
||||
|
||||
The growth of the Gogs project wasn't possible without our world-class sponsors! <Icon icon="heart" iconType="solid" color="#e25555" />
|
||||
|
||||
<Columns cols={2}>
|
||||
<a href="https://www.digitalocean.com/?refcode=5aeb02268b55&utm_campaign=Referral_Invite&utm_medium=Referral_Program&utm_source=badge" target="_blank" style={{borderBottom: "none"}}>
|
||||
<img
|
||||
className="block dark:hidden"
|
||||
src="/images/sponsors/digitalocean-light.png"
|
||||
width={320}
|
||||
noZoom
|
||||
/>
|
||||
<img
|
||||
className="hidden dark:block"
|
||||
src="/images/sponsors/digitalocean-dark.png"
|
||||
width={320}
|
||||
noZoom
|
||||
/>
|
||||
</a>
|
||||
|
||||
<a href="https://www.mintlify.com" target="_blank" style={{borderBottom: "none"}}>
|
||||
<img
|
||||
className="block dark:hidden"
|
||||
src="/images/sponsors/mintlify-light.svg"
|
||||
width={320}
|
||||
noZoom
|
||||
/>
|
||||
<img
|
||||
className="hidden dark:block"
|
||||
src="/images/sponsors/mintlify-dark.svg"
|
||||
width={320}
|
||||
noZoom
|
||||
/>
|
||||
</a>
|
||||
|
||||
<a href="https://www.crowdin.com" target="_blank" style={{borderBottom: "none"}}>
|
||||
<img
|
||||
className="block dark:hidden"
|
||||
src="/images/sponsors/crowdin-light.svg"
|
||||
width={320}
|
||||
noZoom
|
||||
/>
|
||||
<img
|
||||
className="hidden dark:block"
|
||||
src="/images/sponsors/crowdin-dark.svg"
|
||||
width={320}
|
||||
noZoom
|
||||
/>
|
||||
</a>
|
||||
|
||||
<a href="https://www.buildkite.com" target="_blank" style={{borderBottom: "none", paddingTop: "5px"}}>
|
||||
<img
|
||||
className="block dark:hidden"
|
||||
src="/images/sponsors/buildkite-light.svg"
|
||||
width={320}
|
||||
noZoom
|
||||
/>
|
||||
<img
|
||||
className="hidden dark:block"
|
||||
src="/images/sponsors/buildkite-dark.svg"
|
||||
width={320}
|
||||
noZoom
|
||||
/>
|
||||
</a>
|
||||
</Columns>
|
||||
|
||||
## Quickstart
|
||||
|
||||
<CardGroup cols={2}>
|
||||
<Card
|
||||
title="Installation"
|
||||
icon="download"
|
||||
href="/installation"
|
||||
>
|
||||
Get your own Git service up and running in minutes.
|
||||
</Card>
|
||||
<Card
|
||||
title="Configuration"
|
||||
icon="gear"
|
||||
href="/fine-tuning/configuration-primer"
|
||||
>
|
||||
Fine tune your instance exactly the way you want.
|
||||
</Card>
|
||||
<Card
|
||||
title="Features"
|
||||
icon="star"
|
||||
href="/advancing/authentication"
|
||||
>
|
||||
Discover powerful and advanced features.
|
||||
</Card>
|
||||
<Card
|
||||
title="Upgrade"
|
||||
icon="arrow-up"
|
||||
href="/upgrade"
|
||||
>
|
||||
Keep up the version and energy.
|
||||
</Card>
|
||||
</CardGroup>
|
||||
Reference in New Issue
Block a user