0
0
Fork 0
mirror of https://codeberg.org/forgejo/docs.git synced 2024-11-24 18:09:26 -05:00

refactor: use astro content collections for docs

Reviewed-on: https://codeberg.org/forgejo/website/pulls/323

# Conflicts:
#	v1.19/admin/command-line.md
#	v1.19/admin/config-cheat-sheet.md
#	v1.19/admin/database-preparation.md
#	v1.19/admin/email-setup.md
#	v1.19/admin/incoming-email.md
#	v1.19/admin/index.md
#	v1.19/admin/logging-documentation.md
#	v1.19/admin/reverse-proxy.md
#	v1.19/admin/seek-assistance.md
#	v1.19/admin/upgrade.md
#	v1.19/developer/code-forgejo-org.md
#	v1.19/developer/index.md
#	v1.19/index.md
#	v1.19/license.md
#	v1.19/user/agit-support.md
#	v1.19/user/api-usage.md
#	v1.19/user/authentication.md
#	v1.19/user/email-settings.md
#	v1.19/user/first-repository.md
#	v1.19/user/index.md
#	v1.19/user/issue-pull-request-templates.md
#	v1.19/user/issue-tracking-basics.md
#	v1.19/user/labels.md
#	v1.19/user/linked-references.md
#	v1.19/user/merge-message-templates.md
#	v1.19/user/oauth2-provider.md
#	v1.19/user/packages/cargo.md
#	v1.19/user/packages/chef.md
#	v1.19/user/packages/composer.md
#	v1.19/user/packages/conan.md
#	v1.19/user/packages/conda.md
#	v1.19/user/packages/container.md
#	v1.19/user/packages/generic.md
#	v1.19/user/packages/helm.md
#	v1.19/user/packages/index.md
#	v1.19/user/packages/maven.md
#	v1.19/user/packages/npm.md
#	v1.19/user/packages/nuget.md
#	v1.19/user/packages/pub.md
#	v1.19/user/packages/pypi.md
#	v1.19/user/packages/rubygems.md
#	v1.19/user/packages/storage.md
#	v1.19/user/packages/vagrant.md
#	v1.19/user/project.md
#	v1.19/user/protection.md
#	v1.19/user/push-options.md
#	v1.19/user/push-to-create.md
#	v1.19/user/repo-permissions.md
#	v1.19/user/webhooks.md
#	v1.19/user/wiki.md
#	v1.20/user/semver.md
This commit is contained in:
Caesar Schinas 2023-07-26 23:20:30 +01:00
parent 773be6dca2
commit 9af05bfb01
No known key found for this signature in database
GPG key ID: AE9108461BEA5ACF
72 changed files with 99 additions and 171 deletions

View file

@ -1,5 +1,4 @@
---
layout: '~/layouts/Markdown.astro'
title: 'Forgejo Actions administrator guide'
license: 'CC-BY-SA-4.0'
---

View file

@ -1,5 +1,4 @@
---
layout: '~/layouts/Markdown.astro'
title: 'Configuration Cheat Sheet'
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/d0dbe52e76f3038777c3b50066e3636105387ca3/docs/content/doc/administration/config-cheat-sheet.en-us.md'

View file

@ -1,5 +1,4 @@
---
layout: '~/layouts/Markdown.astro'
title: 'Database Preparation'
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/faa28b5a44912f1c63afddab9396bae9e6fe061c/docs/content/doc/installation/database-preparation.en-us.md'

View file

@ -1,5 +1,4 @@
---
layout: '~/layouts/Markdown.astro'
title: 'Email setup'
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/faa28b5a44912f1c63afddab9396bae9e6fe061c/docs/content/doc/administration/email-setup.en-us.md'

View file

@ -1,5 +1,4 @@
---
layout: '~/layouts/Markdown.astro'
title: 'Incoming Email'
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/faa28b5a44912f1c63afddab9396bae9e6fe061c/docs/content/doc/usage/incoming-email.en-us.md'

View file

@ -1,19 +1,18 @@
---
layout: '~/layouts/Markdown.astro'
title: 'Forgejo administrator guide'
---
These documents are targeted to people who run Forgejo on their machines.
- [Seek Assistance](seek-assistance)
- [Installation](installation)
- [Database Preparation](database-preparation)
- [Configuration Cheat Sheet](config-cheat-sheet)
- [Upgrade guide](upgrade)
- [Reverse Proxy](reverse-proxy)
- [Email setup](email-setup)
- [Incoming Email](incoming-email)
- [Logging Configuration](logging-documentation)
- [Actions](actions)
- [Search Engines and robots.txt](search-engines-indexation)
- [Recommended Settings and Tips](recommendations)
- [Seek Assistance](./seek-assistance/)
- [Installation](./installation/)
- [Database Preparation](./database-preparation/)
- [Configuration Cheat Sheet](./config-cheat-sheet/)
- [Upgrade guide](./upgrade/)
- [Reverse Proxy](./reverse-proxy/)
- [Email setup](./email-setup/)
- [Incoming Email](./incoming-email/)
- [Logging Configuration](./logging-documentation/)
- [Actions](./actions/)
- [Search Engines and robots.txt](./search-engines-indexation/)
- [Recommended Settings and Tips](./recommendations/)

View file

@ -1,5 +1,4 @@
---
layout: '~/layouts/Markdown.astro'
title: 'Installation'
license: 'CC-BY-SA-4.0'
origin_url: 'https://github.com/DanielGibson/DanielGibson.github.io/blob/58362695f743a545d2530508ce42d5fe1eea84a9/content/post/setup-vps-with-wireguard-and-forgejo.md'
@ -15,7 +14,7 @@ docker pull codeberg.org/forgejo/forgejo:1.20.1-0
The **1.20** tag is set to be the latest patch release, starting with [1.20.1-0](https://codeberg.org/forgejo/-/packages/container/forgejo/1.20.1-0). **1.20** will then be equal to **1.20.2-0** when it is released and so on.
Upgrading from **1.X** to **1.X+1** (for instance from **1.19** to **1.20**) requires a [manual operation and human verification](../upgrade). However it is possible to use the **X.Y** tag (for instance **1.20**) to get the latest point release automatically.
Upgrading from **1.X** to **1.X+1** (for instance from **1.19** to **1.20**) requires a [manual operation and human verification](../upgrade/). However it is possible to use the **X.Y** tag (for instance **1.20**) to get the latest point release automatically.
Here is a sample [docker-compose](https://docs.docker.com/compose/install/) file:
@ -154,7 +153,7 @@ services:
> **NOTE:** this guide assumes that you'll host on the server with the domain git.example.com.
First, download the Forgejo binary for your CPU architecture and maybe verify the GPG signature,
as described on [the Forgejo download page](/download).
as described on [the Forgejo download page](/download/).
Next, copy the downloaded Forgejo binary to `/usr/local/bin/` (renaming it to just "forgejo")
and make it executable:
@ -208,7 +207,7 @@ When using sqlite as Forgejos database, nothing needs to be done here.
If you need a more powerful database, you can use MySQL/MariaDB or PostgreSQL (apparently sqlite
is good enough for at least 10 users, but might even suffice for more).
See [Forgejos Database Preparation guide](../database-preparation) for
See [Forgejos Database Preparation guide](../database-preparation/) for
setup instructions.
## Install systemd service for Forgejo
@ -269,7 +268,7 @@ write to it after the initial configuration):
Now (as root) edit `/etc/forgejo/app.ini`
> **NOTE:** You'll probably find the
> [Configuration Cheat Sheet](../config-cheat-sheet) and the
> [Configuration Cheat Sheet](../config-cheat-sheet/) and the
> [Example app.ini](https://codeberg.org/forgejo/forgejo/src/branch/forgejo/custom/conf/app.example.ini)
> that contains all options incl. descriptions helpful.
@ -335,7 +334,7 @@ The following changes are recommended if dealing with many large files:
PROTOCOL = sendmail
FROM = "Forgejo Git" <noreply@yourdomain.com>
```
- By default Forgejo will listen to the port 3000 but that can be [changed to 80 with HTTP_PORT](config-cheat-sheet) like this:
- By default Forgejo will listen to the port 3000 but that can be [changed to 80 with HTTP_PORT](./config-cheat-sheet/) like this:
```ini
[server]
HTTP_PORT = 80
@ -351,7 +350,7 @@ You can test sending a mail by clicking the user button on the upper right of th
## General hints for using Forgejo
Sometimes you may want/need to use the Forgejo
[command line interface](command-line).
[command line interface](./command-line/).
Keep in mind that:
- You need to **run it as `git` user**, for example with `$ sudo -u git forgejo command --argument`

View file

@ -1,5 +1,4 @@
---
layout: '~/layouts/Markdown.astro'
title: 'Logging Configuration'
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/faa28b5a44912f1c63afddab9396bae9e6fe061c/docs/content/doc/administration/logging-config.en-us.md'

View file

@ -1,5 +1,4 @@
---
layout: '~/layouts/Markdown.astro'
title: Recommended Settings and Tips
license: 'CC-BY-SA-4.0'
---
@ -27,11 +26,11 @@ The recommended settings are sorted alphabetically rather than by importance.
### `[database].DB_TYPE`
For every action, operation or page you visit, Forgejo must query a database for data. The database is an important part of the Forgejo stack and therefore must be configured with care to ensure proper operation. However, it is difficult to give a recommendation due to its general nature and the many factors that affect the use of the database. So keep the following text in mind when configuring and choosing the database and always test carefully if the configuration suits your situation and [ask for assistance](../seek-assistance) if needed.
For every action, operation or page you visit, Forgejo must query a database for data. The database is an important part of the Forgejo stack and therefore must be configured with care to ensure proper operation. However, it is difficult to give a recommendation due to its general nature and the many factors that affect the use of the database. So keep the following text in mind when configuring and choosing the database and always test carefully if the configuration suits your situation and [ask for assistance](../seek-assistance/) if needed.
If your instance sees a low to moderate amount of activity, it is recommended to change this value to **sqlite3**. [SQLite3](https://www.sqlite.org/index.html) is a simple, non-maintenance requirement and one file on disk database. It is by far the easiest database to configure and has many other advantages over the other databases, but it becomes a poor choice once you see a lot of concurrent activity in which case performance may decrease, but SQLite can go a long way in the early years of an instance. It is also recommended to change `[database].SQLITE_JOURNAL_MODE` to `WAL`, which allows for a modern and faster way of tracking SQL queries.
If your instances see a high amount of activity, it is recommended to change this value to **mysql**, **postgres** or **mssql**. There is no best managed database server, and it mainly depends on your previous experience and knowledge about the database you want to use, all three can handle large amounts of activity, please refer to the [database-configuration](../config-cheat-sheet#database-database) about what other values should be configured to connect to the database server.
If your instances see a high amount of activity, it is recommended to change this value to **mysql**, **postgres** or **mssql**. There is no best managed database server, and it mainly depends on your previous experience and knowledge about the database you want to use, all three can handle large amounts of activity, please refer to the [database-configuration](../config-cheat-sheet#database-database/) about what other values should be configured to connect to the database server.
**Warning:** Keep in mind that transitioning to another database with an existing database is not a trivial task and must be done carefully.
@ -59,7 +58,7 @@ If your instance does not need to adhere to a security policy that mandates a di
In recent years, spam bots have gotten smarter and have automated more than ever. A simple register form such as in Forgejo is a simple task for bots to register a new user and comment wherever they can about their favorite scam website. Forgejo provides the option to enable captcha on the register form.
If your instance has an open registration, it is recommended to change this value to **true**. You also need to choose which captcha you want to use, you can find more about that in the [service configuration](../config-cheat-sheet#service-service). Keep in mind that certain types of captcha limit the accessibility of registering new users because they often use images that are difficult to see.
If your instance has an open registration, it is recommended to change this value to **true**. You also need to choose which captcha you want to use, you can find more about that in the [service configuration](../config-cheat-sheet#service-service/). Keep in mind that certain types of captcha limit the accessibility of registering new users because they often use images that are difficult to see.
### `[ui].ONLY_SHOW_RELEVANT_REPOS`

View file

@ -1,5 +1,4 @@
---
layout: '~/layouts/Markdown.astro'
title: 'Reverse proxy'
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/faa28b5a44912f1c63afddab9396bae9e6fe061c/docs/content/doc/usage/authentication.en-us.md'

View file

@ -1,5 +1,4 @@
---
layout: '~/layouts/Markdown.astro'
title: 'Search Engines Indexation'
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/faa28b5a44912f1c63afddab9396bae9e6fe061c/docs/content/doc/administration/search-engines-indexation.en-us.md'

View file

@ -1,5 +1,4 @@
---
layout: '~/layouts/Markdown.astro'
title: 'Seek Assistance'
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/faa28b5a44912f1c63afddab9396bae9e6fe061c/docs/content/doc/help/seek-help.en-us.md'

View file

@ -1,5 +1,4 @@
---
layout: '~/layouts/Markdown.astro'
title: 'Upgrade guide'
license: 'CC-BY-SA-4.0'
origin_url: 'https://forgejo.gna.org/Hostea/admin-guide/src/branch/master/README.md'

View file

@ -1,5 +1,4 @@
---
layout: '~/layouts/Markdown.astro'
title: Code of Conduct and moderation team
license: 'CC-BY-SA-4.0'
---

View file

@ -1,5 +1,4 @@
---
layout: '~/layouts/Markdown.astro'
title: Developer Certificate of Origin (DCO)
license: 'CC-BY-SA-4.0'
---

View file

@ -1,5 +1,4 @@
---
layout: '~/layouts/Markdown.astro'
title: Bugs, features and discussions
license: 'CC-BY-SA-4.0'
---

View file

@ -1,5 +1,4 @@
---
layout: '~/layouts/Markdown.astro'
title: Governance
license: 'CC-BY-SA-4.0'
---

View file

@ -1,5 +1,4 @@
---
layout: '~/layouts/Markdown.astro'
title: Release management
license: 'CC-BY-SA-4.0'
---
@ -42,7 +41,7 @@ The TL;DR: to publish a vX.Y.Z-N release is to:
### Cherry pick the latest commits from Gitea
The vX.Y/forgejo branch is populated as part of the [rebase on top of Gitea](WORKFLOW.md). The release happens in between rebase and it is worth checking if the matching Gitea branch, release/vX.Y contains commits that should be included in the release.
The vX.Y/forgejo branch is populated as part of the [rebase on top of Gitea](./workflow/). The release happens in between rebase and it is worth checking if the matching Gitea branch, release/vX.Y contains commits that should be included in the release.
- `cherry-pick -x` the commits
- push the vX.Y/forgejo branch including the commits
@ -105,12 +104,12 @@ providing the secrets from the command line.
### Securing the release token and cryptographic keys
For both the Forgejo runner and Forgejo itself, copying and signing the release artifacts (container images and binaries) happen on a Forgejo isntance running [behind a VPN](infrastructure#octopuce) to safeguard the token that has write access to the Forgejo repository as well as the cryptographic key used to sign the releases.
For both the Forgejo runner and Forgejo itself, copying and signing the release artifacts (container images and binaries) happen on a Forgejo isntance running [behind a VPN](./infrastructure#octopuce/) to safeguard the token that has write access to the Forgejo repository as well as the cryptographic key used to sign the releases.
### Website update
- Restart the last CI build at https://codeberg.org/forgejo/website/src/branch/main/
- Verify [https://forgejo.org/download/](/download) points to the expected release
- Verify [https://forgejo.org/download/](/download/) points to the expected release
- Update the [documentation link to the latest version](https://codeberg.org/forgejo/website/src/commit/e63c6f8ab64876b10b86de1d18162b6ccb87bd99/.woodpecker.yml#L35)
- Manually try the instructions to work

View file

@ -1,5 +1,4 @@
---
layout: '~/layouts/Markdown.astro'
title: Secrets
license: 'CC-BY-SA-4.0'
---

View file

@ -1,5 +1,4 @@
---
layout: '~/layouts/Markdown.astro'
title: Development workflow
license: 'CC-BY-SA-4.0'
---

View file

@ -1,5 +1,4 @@
---
layout: '~/layouts/Markdown.astro'
title: code.forgejo.org
license: 'CC-BY-SA-4.0'
---

View file

@ -1,5 +1,4 @@
---
layout: '~/layouts/Markdown.astro'
title: 'Compiling from source'
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/faa28b5a44912f1c63afddab9396bae9e6fe061c/docs/content/doc/installation/from-source.en-us.md'

View file

@ -1,5 +1,4 @@
---
layout: '~/layouts/Markdown.astro'
title: 'Forgejo developer guide'
---
@ -7,17 +6,17 @@ This area will be targeted to people who want to hack Forgejo and adjust it to
their needs.
- For everyone involved
- [Code of Conduct](COC)
- [Bugs, features, security and others discussions](DISCUSSIONS)
- [Governance](GOVERNANCE)
- [Code of Conduct](./coc/)
- [Bugs, features, security and others discussions](./discussions/)
- [Governance](./governance/)
- [Sustainability and funding](https://codeberg.org/forgejo/sustainability/src/branch/master/README)
- For contributors
- [Compiling from source](from-source)
- [Developer Certificate of Origin (DCO)](DCO)
- [Development workflow](WORKFLOW)
- [code.forgejo.org](code-forgejo-org)
- [Compiling from source](./from-source/)
- [Developer Certificate of Origin (DCO)](./dco/)
- [Development workflow](./workflow/)
- [code.forgejo.org](./code-forgejo-org/)
- [Forgejo runner implementation notes](https://code.forgejo.org/forgejo/runner/#hacking)
- For maintainers
- [Hardware infrastructure](infrastructure)
- [Release management](RELEASE)
- [Secrets](SECRETS)
- [Hardware infrastructure](./infrastructure/)
- [Release management](./release/)
- [Secrets](./secrets/)

View file

@ -1,5 +1,4 @@
---
layout: '~/layouts/Markdown.astro'
title: Hardware infrastructure
license: 'CC-BY-SA-4.0'
---

View file

@ -1,12 +1,11 @@
---
layout: '~/layouts/Markdown.astro'
title: 'Forgejo v1.20 documentation'
---
- [What is Forgejo?](/)
- [Installation](admin/installation)
- [FAQ](/faq)
- [Administrator guide](admin)
- [User guide](user)
- [Developer guide](developer)
- [License](license)
- [Installation](./admin/installation/)
- [FAQ](/faq/)
- [Administrator guide](./admin/)
- [User guide](./user/)
- [Developer guide](./developer/)
- [License](./license/)

View file

@ -1,5 +1,4 @@
---
layout: '~/layouts/Markdown.astro'
title: 'License'
---

View file

@ -1,5 +1,4 @@
---
layout: '~/layouts/Markdown.astro'
title: 'Forgejo Actions user guide'
license: 'CC-BY-SA-4.0'
similar: 'https://github.com/go-gitea/gitea/blob/main/docs/content/doc/usage/actions/faq.en-us.md https://docs.github.com/en/actions'
@ -32,7 +31,7 @@ The following guide explains key **concepts** to help understand how `workflows`
## Forgejo runner
`Forgejo` itself does not run the `jobs`, it relies on the [Forgejo runner](https://code.forgejo.org/forgejo/runner) to do so. See the [Forgejo Actions administrator guide](../../admin/actions) for more information.
`Forgejo` itself does not run the `jobs`, it relies on the [Forgejo runner](https://code.forgejo.org/forgejo/runner) to do so. See the [Forgejo Actions administrator guide](../../admin/actions/) for more information.
## Actions
@ -129,7 +128,7 @@ A list of command and arguments, equivalent to [[COMMAND] [ARG...]](https://docs
A string of additional options, as documented [docker run](https://docs.docker.com/engine/reference/commandline/run/). For instance: "--workdir /myworkdir --ulimit nofile=1024:1024".
> **NOTE:** the `--volume` option is restricted to a whitelist of volumes configured in the runner executing the task. See the [Forgejo Actions administrator guide](../../admin/actions) for more information.
> **NOTE:** the `--volume` option is restricted to a whitelist of volumes configured in the runner executing the task. See the [Forgejo Actions administrator guide](../../admin/actions/) for more information.
### username
@ -145,7 +144,7 @@ A `Forgejo runner` listens on a `Forgejo` instance, waiting for jobs. To figure
![list of runners](../../../../images/v1.20/user/actions/list-of-runners.png)
Some runners are **Global** and are available for every repository, others are only available for the repositories within a given user or organization. And there can even be runners dedicated to a single repository. The `Forgejo` administrator is the only one able to launch a **Global** runner. But the user who owns an organization can launch a runner without requiring any special permission. All they need to do is to get a runner registration token and install the runner on their own laptop or on a server of their choosing (see the [Forgejo Actions administrator guide](../../admin/actions) for more information).
Some runners are **Global** and are available for every repository, others are only available for the repositories within a given user or organization. And there can even be runners dedicated to a single repository. The `Forgejo` administrator is the only one able to launch a **Global** runner. But the user who owns an organization can launch a runner without requiring any special permission. All they need to do is to get a runner registration token and install the runner on their own laptop or on a server of their choosing (see the [Forgejo Actions administrator guide](../../admin/actions/) for more information).
Clicking on the pencil icon next to a runner shows the list of tasks it executed, with the status and a link to display the details of the execution.
@ -256,7 +255,7 @@ jobs:
means that the `Forgejo runner` that claims to provide a kind of machine labelled `docker` will be selected by `Forgejo` and sent the job to be run.
The actual machine provided by the runner **entirely depends on how the `Forgejo runner` was registered** (see the [Forgejo Actions administrator guide](../../admin/actions) for more information).
The actual machine provided by the runner **entirely depends on how the `Forgejo runner` was registered** (see the [Forgejo Actions administrator guide](../../admin/actions/) for more information).
The list of available `labels` for a given repository can be seen in the `/{owner}/{repo}/settings/actions/runners` page.
@ -278,7 +277,7 @@ container:
A string of additional options, as documented [docker run](https://docs.docker.com/engine/reference/commandline/run/). For instance: "--workdir /myworkdir --ulimit nofile=1024:1024".
> **NOTE:** the `--volume` option is restricted to a whitelist of volumes configured in the runner executing the task. See the [Forgejo Actions administrator guide](../../admin/actions) for more information.
> **NOTE:** the `--volume` option is restricted to a whitelist of volumes configured in the runner executing the task. See the [Forgejo Actions administrator guide](../../admin/actions/) for more information.
#### LXC

View file

@ -1,5 +1,4 @@
---
layout: '~/layouts/Markdown.astro'
title: 'Agit Setup'
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/faa28b5a44912f1c63afddab9396bae9e6fe061c/docs/content/doc/usage/agit-support.en-us.md'

View file

@ -1,5 +1,4 @@
---
layout: '~/layouts/Markdown.astro'
title: 'API Usage'
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/faa28b5a44912f1c63afddab9396bae9e6fe061c/docs/content/doc/development/api-usage.en-us.md'

View file

@ -1,5 +1,4 @@
---
layout: '~/layouts/Markdown.astro'
title: 'Authentication'
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/faa28b5a44912f1c63afddab9396bae9e6fe061c/docs/content/doc/usage/authentication.en-us.md'

View file

@ -1,5 +1,4 @@
---
layout: '~/layouts/Markdown.astro'
title: Blocking a user
license: 'CC-BY-SA-4.0'
---

View file

@ -1,5 +1,4 @@
---
layout: '~/layouts/Markdown.astro'
title: 'Email Settings'
license: 'CC-BY-SA-4.0'
origin_url: 'https://codeberg.org/Codeberg/Documentation/src/commit/5d457efc069b52d512632fea024917e0848346cd/content/getting-started/email-settings.md'

View file

@ -1,5 +1,4 @@
---
layout: '~/layouts/Markdown.astro'
title: Your First Repository
license: 'CC-BY-SA-4.0'
origin_url: 'https://codeberg.org/Codeberg/Documentation/src/commit/5d457efc069b52d512632fea024917e0848346cd/content/getting-started/first-repository.md'
@ -32,15 +31,15 @@ Here's an explanation of the form's fields:
- **Template** Occasionally you may want to generate your repository from an existing template. In that case, you can specify that template here. Otherwise, simply leave this field empty.
- **Issue Labels** If you want to initialize your project's issue tracker with a set of labels that you can use to categorize issues, you can choose one here. You don't have to choose this right away though, as you can choose and modify issue labels at a later time as well.
- **.gitignore** A [.gitignore](https://git-scm.com/docs/gitignore) file defines which files Git should not keep track of. This is useful, for example to prevent configuration files or binaries to be tracked in version control. You can choose to add a pre-defined file matching the programming language you use now, or add one manually later.
- **License** Here, you can choose from a list of FSF/OSI approved licenses. A `LICENSE` file will then be added to the repository. For some help on choosing the correct license, have a look at our [licensing article](/getting-started/licensing).
- **README** is the first file one should read when accessing a repository. It's also the first file displayed when accessing a repository, a bit like the "homepage" of your repository. On Forgejo, this is interpreted as a [Markdown](/markdown) file.
- **License** Here, you can choose from a list of FSF/OSI approved licenses. A `LICENSE` file will then be added to the repository. For some help on choosing the correct license, have a look at our [licensing article](/getting-started/licensing/).
- **README** is the first file one should read when accessing a repository. It's also the first file displayed when accessing a repository, a bit like the "homepage" of your repository. On Forgejo, this is interpreted as a [Markdown](/markdown/) file.
- **Initialize repository** In order to add the `LICENSE`, `README` and `.gitignore` files mentioned above to your new repository, make sure you tick this box.
- **Default branch** Using this field, you can choose how to name the default branch of your Git repository. We recommend you use the predefined default.
It's okay to only specify owner and repository name, if you want to get started quickly.
After filling out the fields, click the green "Create Repository" button on the bottom of the page.
You should now see a screen similar to the one below. If you haven't chosen to generate `LICENSE`, `README` and `.gitignore` the screen might show instructions instead, which will vanish after [your first commit](#making-your-first-commit).
You should now see a screen similar to the one below. If you haven't chosen to generate `LICENSE`, `README` and `.gitignore` the screen might show instructions instead, which will vanish after [your first commit](#making-your-first-commit/).
![screenshot showing a freshly baken repository](../../../../images/v1.20/user/first-repository/create-repo-3.png)
@ -51,7 +50,7 @@ Here's what the most important buttons do:
- **The Repository Tabs (3)** contain links to every important feature within this repository:
- **Code** lets you browse through all versions of this repository's code.
- **Issues** is a very important communication tool between the author, their users and their contributors. Think of it as part bug-tracker, part forum.
For more information on this, have a look at [The Basics of Issue Tracking](/getting-started/issue-tracking-basics)
For more information on this, have a look at [The Basics of Issue Tracking](/getting-started/issue-tracking-basics/)
- **Pull Requests** is where other users can ask the author to "pull" in code, from a fork into the author's program.
- **Releases** is a space where the author can upload finished versions of their program, e.g. binaries
- **Wiki** is a basic wiki feature built into Forgejo.
@ -65,7 +64,7 @@ After creating a new repository, as laid out in the previous section, you can no
In this guide, we'll focus on connecting to Forgejo via HTTP using Git on the command line, but note that there are multiple other ways to connect to Forgejo, as laid out in more detail in the articles:
- [Clone & Commit via CLI](/git/clone-commit-via-cli/) and
- [Clone & Commit via Web](/git/clone-commit-via-web)
- [Clone & Commit via Web](/git/clone-commit-via-web/)
> Although we use HTTP in this Getting Started guide, it is a good idea to setup SSH-based authentication once you feel confident to do so

View file

@ -1,5 +1,4 @@
---
layout: '~/layouts/Markdown.astro'
title: 'Forgejo user guide'
---
@ -7,44 +6,44 @@ These documents are targeted to people who are using Forgejo but are not
involved in running it on their machines.
- Getting started
- [Your First Repository](first-repository)
- [The Basics of Issue Tracking](issue-tracking-basics)
- [Integrated Wiki](wiki)
- [Email Settings](email-settings)
- [Your First Repository](./first-repository/)
- [The Basics of Issue Tracking](./issue-tracking-basics/)
- [Integrated Wiki](./wiki/)
- [Email Settings](./email-settings/)
- Collaborating with Others
- [Projects / Kanban boards](project)
- [Projects / Kanban boards](./project/)
- [Pull requests and Git flow](https://docs.codeberg.org/collaborating/pull-requests-and-git-flow/)
- [Invite Collaborators](https://docs.codeberg.org/collaborating/invite-collaborators/)
- [Create and Manage an Organization](https://docs.codeberg.org/collaborating/create-organization/)
- [Repository Permissions](repo-permissions)
- [Repository Permissions](./repo-permissions/)
- [Resolve Conflicts](https://docs.codeberg.org/collaborating/resolve-conflicts/)
- [Citable Code](https://docs.codeberg.org/collaborating/citable-code/)
- [Labels](labels)
- [Automatically Linked References](linked-references)
- [Blocking users](blocking-user)
- [Profile costumization](profile)
- [Labels](./labels/)
- [Automatically Linked References](./linked-references/)
- [Blocking users](./blocking-user/)
- [Profile costumization](./profile/)
- Working with Git Repositories
- [Clone & Commit via Web](https://docs.codeberg.org/git/clone-commit-via-web/)
- [Tags and Releases](https://docs.codeberg.org/git/using-tags/)
- [Branch and tag protection](protection)
- [Branch and tag protection](./protection/)
- Advanced Usage
- [Issue and Pull Request Templates](issue-pull-request-templates)
- [Actions](actions)
- [Merge Message templates](merge-message-templates)
- [Webhooks](webhooks)
- [Issue and Pull Request Templates](./issue-pull-request-templates/)
- [Actions](./actions/)
- [Merge Message templates](./merge-message-templates/)
- [Webhooks](./webhooks/)
- Authentication
- [Generating an Access Token](https://docs.codeberg.org/advanced/access-token/)
- [Access Token scope](token-scope)
- [LDAP, PAM, FreeIPA](authentication)
- [OAuth2, Client Types](oauth2-provider)
- [Semantic version](semver)
- [API Usage](api-usage)
- [Access Token scope](./token-scope/)
- [LDAP, PAM, FreeIPA](./authentication/)
- [OAuth2, Client Types](./oauth2-provider/)
- [Semantic version](./semver/)
- [API Usage](./api-usage/)
- [API Reference](https://codeberg.org/api/swagger)
- [Migrating Repositories](https://docs.codeberg.org/advanced/migrating-repos/)
- [Push Options](push-options)
- [Push to create](push-to-create)
- [Agit setup](agit-support)
- [Packages](packages)
- [Push Options](./push-options/)
- [Push to create](./push-to-create/)
- [Agit setup](./agit-support/)
- [Packages](./packages/)
- See also
- [Codeberg guide on Git](https://docs.codeberg.org/git/)
- [Codeberg guide on Markdown](https://docs.codeberg.org/markdown/)

View file

@ -1,5 +1,4 @@
---
layout: '~/layouts/Markdown.astro'
title: 'Issue and Pull Request Templates'
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/faa28b5a44912f1c63afddab9396bae9e6fe061c/docs/content/doc/usage/issue-pull-request-templates.en-us.md'

View file

@ -1,5 +1,4 @@
---
layout: '~/layouts/Markdown.astro'
title: 'The Basics of Issue Tracking'
license: 'CC-BY-SA-4.0'
origin_url: 'https://codeberg.org/Codeberg/Documentation/src/commit/5d457efc069b52d512632fea024917e0848346cd/content/getting-started/issue-tracking-basics.md'

View file

@ -1,5 +1,4 @@
---
layout: '~/layouts/Markdown.astro'
title: 'Labels'
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/faa28b5a44912f1c63afddab9396bae9e6fe061c/docs/content/doc/usage/labels.en-us.md'

View file

@ -1,5 +1,4 @@
---
layout: '~/layouts/Markdown.astro'
title: 'Automatically Linked References in Issues, Pull Requests and Commit Messages'
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/faa28b5a44912f1c63afddab9396bae9e6fe061c/docs/content/doc/usage/linked-references.en-us.md'

View file

@ -1,5 +1,4 @@
---
layout: '~/layouts/Markdown.astro'
title: 'Merge Message templates'
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/faa28b5a44912f1c63afddab9396bae9e6fe061c/docs/content/doc/usage/merge-message-templates.en-us.md'

View file

@ -1,5 +1,4 @@
---
layout: '~/layouts/Markdown.astro'
title: 'OAuth2 provider'
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/faa28b5a44912f1c63afddab9396bae9e6fe061c/docs/content/doc/development/oauth2-provider.en-us.md'
@ -28,7 +27,7 @@ To use the Authorization Code Grant as a third party application it is required
## Scoped Tokens
See the [Access Token scope](../token-scope) section for more information.
See the [Access Token scope](../token-scope/) section for more information.
## Client types

View file

@ -1,5 +1,4 @@
---
layout: '~/layouts/Markdown.astro'
title: 'Alpine Packages Repository'
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/faa28b5a44912f1c63afddab9396bae9e6fe061c/docs/content/doc/usage/packages/alpine.en-us.md'

View file

@ -1,5 +1,4 @@
---
layout: '~/layouts/Markdown.astro'
title: 'Cargo Package Registry'
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/faa28b5a44912f1c63afddab9396bae9e6fe061c/docs/content/doc/usage/packages/cargo.en-us.md'

View file

@ -1,5 +1,4 @@
---
layout: '~/layouts/Markdown.astro'
title: 'Chef Package Registry'
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/faa28b5a44912f1c63afddab9396bae9e6fe061c/docs/content/doc/usage/packages/chef.en-us.md'

View file

@ -1,5 +1,4 @@
---
layout: '~/layouts/Markdown.astro'
title: 'Composer Package Registry'
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/faa28b5a44912f1c63afddab9396bae9e6fe061c/docs/content/doc/usage/packages/composer.en-us.md'

View file

@ -1,5 +1,4 @@
---
layout: '~/layouts/Markdown.astro'
title: 'Conan Package Registry'
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/faa28b5a44912f1c63afddab9396bae9e6fe061c/docs/content/doc/usage/packages/conan.en-us.md'

View file

@ -1,5 +1,4 @@
---
layout: '~/layouts/Markdown.astro'
title: 'Conda Package Registry'
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/faa28b5a44912f1c63afddab9396bae9e6fe061c/docs/content/doc/usage/packages/conda.en-us.md'

View file

@ -1,5 +1,4 @@
---
layout: '~/layouts/Markdown.astro'
title: 'Container Registry'
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/faa28b5a44912f1c63afddab9396bae9e6fe061c/docs/content/doc/usage/packages/container.en-us.md'

View file

@ -1,5 +1,4 @@
---
layout: '~/layouts/Markdown.astro'
title: 'CRAN Package Registry'
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/faa28b5a44912f1c63afddab9396bae9e6fe061c/docs/content/doc/usage/packages/cran.en-us.md'

View file

@ -1,5 +1,4 @@
---
layout: '~/layouts/Markdown.astro'
title: 'Debian Package Registry'
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/faa28b5a44912f1c63afddab9396bae9e6fe061c/docs/content/doc/usage/packages/debian.en-us.md'

View file

@ -1,5 +1,4 @@
---
layout: '~/layouts/Markdown.astro'
title: 'Generic Package Registry'
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/faa28b5a44912f1c63afddab9396bae9e6fe061c/docs/content/doc/usage/packages/generic.en-us.md'

View file

@ -1,5 +1,4 @@
---
layout: '~/layouts/Markdown.astro'
title: 'Go Package Registry'
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/faa28b5a44912f1c63afddab9396bae9e6fe061c/docs/content/doc/usage/packages/go.en-us.md'

View file

@ -1,5 +1,4 @@
---
layout: '~/layouts/Markdown.astro'
title: 'Helm Chart Registry'
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/faa28b5a44912f1c63afddab9396bae9e6fe061c/docs/content/doc/usage/packages/helm.en-us.md'

View file

@ -1,5 +1,4 @@
---
layout: '~/layouts/Markdown.astro'
title: 'Package Registry'
---
@ -7,29 +6,29 @@ title: 'Package Registry'
The following package managers are currently supported:
| Name | Language | Package client |
| ---------------------- | ---------- | -------------------------- |
| [Alpine](alpine) | - | `apk` |
| [Cargo](cargo) | Rust | `cargo` |
| [Chef](chef) | - | `knife` |
| [Composer](composer) | PHP | `composer` |
| [Conan](conan) | C++ | `conan` |
| [Conda](conda) | - | `conda` |
| [Container](container) | - | any OCI compliant client |
| [CRAN](cran) | R | |
| [Debian](debian) | - | `apt` |
| [Generic](generic) | - | any HTTP client |
| [Go](go) | Go | `go` |
| [Helm](helm) | - | any HTTP client, `cm-push` |
| [Maven](maven) | Java | `mvn`, `gradle` |
| [npm](npm) | JavaScript | `npm`, `yarn`, `pnpm` |
| [NuGet](nuget) | .NET | `nuget` |
| [Pub](pub) | Dart | `dart`, `flutter` |
| [PyPI](pypi) | Python | `pip`, `twine` |
| [RPM](rpm) | - | `yum`, `dnf` |
| [RubyGems](rubygems) | Ruby | `gem`, `Bundler` |
| [Swift](swift) | Swift | `swift` |
| [Vagrant](vagrant) | - | `vagrant` |
| Name | Language | Package client |
| ------------------------- | ---------- | -------------------------- |
| [Alpine](./alpine/) | - | `apk` |
| [Cargo](./cargo/) | Rust | `cargo` |
| [Chef](./chef/) | - | `knife` |
| [Composer](./composer/) | PHP | `composer` |
| [Conan](./conan/) | C++ | `conan` |
| [Conda](./conda/) | - | `conda` |
| [Container](./container/) | - | any OCI compliant client |
| [CRAN](./cran/) | R | |
| [Debian](./debian/) | - | `apt` |
| [Generic](./generic/) | - | any HTTP client |
| [Go](./go/) | Go | `go` |
| [Helm](./helm/) | - | any HTTP client, `cm-push` |
| [Maven](./maven/) | Java | `mvn`, `gradle` |
| [npm](./npm/) | JavaScript | `npm`, `yarn`, `pnpm` |
| [NuGet](./nuget/) | .NET | `nuget` |
| [Pub](./pub/) | Dart | `dart`, `flutter` |
| [PyPI](./pypi/) | Python | `pip`, `twine` |
| [RPM](./rpm/) | - | `yum`, `dnf` |
| [RubyGems](./rubygems/) | Ruby | `gem`, `Bundler` |
| [Swift](./swift/) | Swift | `swift` |
| [Vagrant](./vagrant/) | - | `vagrant` |
**The following paragraphs only apply if Packages are not globally disabled!**

View file

@ -1,5 +1,4 @@
---
layout: '~/layouts/Markdown.astro'
title: 'Maven Package Registry'
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/faa28b5a44912f1c63afddab9396bae9e6fe061c/docs/content/doc/usage/packages/maven.en-us.md'

View file

@ -1,5 +1,4 @@
---
layout: '~/layouts/Markdown.astro'
title: 'npm Package Registry'
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/faa28b5a44912f1c63afddab9396bae9e6fe061c/docs/content/doc/usage/packages/npm.en-us.md'

View file

@ -1,5 +1,4 @@
---
layout: '~/layouts/Markdown.astro'
title: 'NuGet Package Registry'
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/faa28b5a44912f1c63afddab9396bae9e6fe061c/docs/content/doc/usage/packages/nuget.en-us.md'

View file

@ -1,5 +1,4 @@
---
layout: '~/layouts/Markdown.astro'
title: 'Pub Package Registry'
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/faa28b5a44912f1c63afddab9396bae9e6fe061c/docs/content/doc/usage/packages/pub.en-us.md'

View file

@ -1,5 +1,4 @@
---
layout: '~/layouts/Markdown.astro'
title: 'PyPI Package Registry'
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/faa28b5a44912f1c63afddab9396bae9e6fe061c/docs/content/doc/usage/packages/pypi.en-us.md'

View file

@ -1,5 +1,4 @@
---
layout: '~/layouts/Markdown.astro'
title: 'RPM Package Registry'
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/faa28b5a44912f1c63afddab9396bae9e6fe061c/docs/content/doc/usage/packages/rpm.en-us.md'

View file

@ -1,5 +1,4 @@
---
layout: '~/layouts/Markdown.astro'
title: 'RubyGems Packages Repository'
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/faa28b5a44912f1c63afddab9396bae9e6fe061c/docs/content/doc/usage/packages/rubygems.en-us.md'

View file

@ -1,5 +1,4 @@
---
layout: '~/layouts/Markdown.astro'
title: 'Storage'
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/faa28b5a44912f1c63afddab9396bae9e6fe061c/docs/content/doc/usage/packages/storage.en-us.md'

View file

@ -1,5 +1,4 @@
---
layout: '~/layouts/Markdown.astro'
title: 'Swift Packages Repository'
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/faa28b5a44912f1c63afddab9396bae9e6fe061c/docs/content/doc/usage/packages/swift.en-us.md'

View file

@ -1,5 +1,4 @@
---
layout: '~/layouts/Markdown.astro'
title: 'Vagrant Packages Repository'
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/faa28b5a44912f1c63afddab9396bae9e6fe061c/docs/content/doc/usage/packages/vagrant.en-us.md'

View file

@ -1,5 +1,4 @@
---
layout: '~/layouts/Markdown.astro'
title: 'Profile customization'
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/faa28b5a44912f1c63afddab9396bae9e6fe061c/docs/content/doc/usage/profile-readme.en-us.md'

View file

@ -1,5 +1,4 @@
---
layout: '~/layouts/Markdown.astro'
title: 'Projects'
license: 'CC-BY-SA-4.0'
---

View file

@ -1,5 +1,4 @@
---
layout: '~/layouts/Markdown.astro'
title: 'Branch and tag protection'
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/faa28b5a44912f1c63afddab9396bae9e6fe061c/docs/content/doc/usage/protected-tags.en-us.md'

View file

@ -1,5 +1,4 @@
---
layout: '~/layouts/Markdown.astro'
title: 'Push Options'
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/faa28b5a44912f1c63afddab9396bae9e6fe061c/docs/content/doc/usage/push.en-us.md'

View file

@ -1,5 +1,4 @@
---
layout: '~/layouts/Markdown.astro'
title: 'Repository Permissions'
license: 'CC-BY-SA-4.0'
origin_url: 'https://codeberg.org/Codeberg/Documentation/src/commit/5d457efc069b52d512632fea024917e0848346cd/content/collaborating/repo-permissions.md'

View file

@ -1,5 +1,4 @@
---
layout: '~/layouts/Markdown.astro'
title: Semantic version
license: 'CC-BY-SA-4.0'
---

View file

@ -1,5 +1,4 @@
---
layout: '~/layouts/Markdown.astro'
title: 'Access Token scope'
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/62ac3251fa545d32bdfc9ff824106b97ec63edbb/docs/content/doc/development/oauth2-provider.en-us.md'

View file

@ -1,5 +1,4 @@
---
layout: '~/layouts/Markdown.astro'
title: 'Webhooks'
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/faa28b5a44912f1c63afddab9396bae9e6fe061c/docs/content/doc/usage/webhooks.en-us.md'

View file

@ -1,5 +1,4 @@
---
layout: '~/layouts/Markdown.astro'
title: 'Integrated Wiki'
license: 'CC-BY-SA-4.0'
origin_url: 'https://codeberg.org/Codeberg/Documentation/src/commit/5d457efc069b52d512632fea024917e0848346cd/content/getting-started/wiki.md'
@ -102,7 +101,7 @@ Very basic example for a sidebar:
### Content
- [Page 1](Page-1)
- [Page 1](./Page-1/)
> knuts wiki
```