foster/forgejo-docs
0
0
Fork 0
mirror of https://codeberg.org/forgejo/docs.git synced 2024-11-21 17:36:59 -05:00
Code Issues Activity

Add next.forgejo.org documentation

Browse source
This commit is contained in:
crystal 2023-08-29 19:49:52 -06:00
parent ac639fae68
commit b0319eaa02
No known key found for this signature in database
GPG key ID: 1122054731F7CC43
4 changed files with 86 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
docs/developer/index.md
View file

@ -15,6 +15,7 @@ their needs.
- [Developer Certificate of Origin (DCO)](./dco/)
- [Development workflow](./workflow/)
- [code.forgejo.org](./code-forgejo-org/)
- [next.forgejo.org](./next-forgejo-org/)
- [Forgejo runner implementation notes](https://code.forgejo.org/forgejo/runner/#hacking)
- For maintainers
- [Hardware infrastructure](./infrastructure/)

53
docs/developer/next-forgejo-org.md Normal file
View file

@ -0,0 +1,53 @@
---
title: next.forgejo.org
license: 'CC-BY-SA-4.0'
---
_This is the developer documentation for Forgejo Next, covering technical
details for Forgejo contributors.
[Go to end-user documentation for service overview.](../../user/forgejo-next/)_
https://next.forgejo.org, also known as Forgejo Next, is Forgejo's
official testing and demonstration instance. The specific version of
Forgejo running on this instance varies depending on the status of the
latest release branch.
Typically, the instance will be running a recent build straight from the
`forgejo` branch, meaning it contains experimental code that will be
included in the next major version of Forgejo. When a release branch is
created and release candidates are posted, Forgejo Next will be switched
to the latest release candidate. Release candidates are to be deployed
until a stable release is available, at which point the stable release
will be deployed. After the release has been sufficiently tested (often
after it's deployed to Codeberg), next.forgejo.org will then be upgraded
back to the `forgejo` branch.
next.forgejo.org is generously hosted by Codeberg to help the Forgejo
community test and demonstrate its product. The instance runs inside
its own LXC container on Codeberg's infrastructure. When SNI-enabled
traffic bound for next.forgejo.org reaches Codeberg's proxy on port 443,
the raw TCP traffic is forwarded to the container, allowing the instance
to terminate the SSL/TLS and obtain its own certificate using Forgejo's
inbuilt ACME client. The proxy also forwards port 2222 to the container
for SSH access. Additionally, Codeberg provides a database on their
existing MariaDB host for the instance to use.
Inside the container, the Forgejo binary is manually installed to
`/usr/local/bin/forgejo` with the service managed by systemd.
Configuration is loaded from `/etc/forgejo/app.ini`.
_TODO: Semi-automated deployment with Forgejo Actions._
Since the container is inside Codeberg's infrastructure, logging into
it for maintainence is subject to Codeberg's security policy. If you
need to access it, please
[seek approval from the Forgejo community](https://codeberg.org/forgejo/governance/issues),
then contact Codeberg staff for more information.
<!-- TODO: Add more information about the requirements and how to set it up after seeking Codeberg's approval -->
When working with the container, it's important to avoid breaking anything
in a way that will cause any user data to be lost. Users of next.forgejo.org
are expected to keep their own backups of any important data they upload,
but we also wish to encourage casual use of the instance for legitimate
projects, not just test repos, so the instance should _not_ be considered
disposable.

31
docs/user/forgejo-next.md Normal file
View file

@ -0,0 +1,31 @@
---
title: Forgejo Next
license: 'CC-BY-SA-4.0'
---
https://next.forgejo.org, also known as Forgejo Next, is Forgejo's
official testing and demonstration instance. Everyone is encouraged to
use it to experiment with Forgejo, try out upcoming features, search for
bugs, or even casually host a project.
Internal registration is currently not allowed, but you may create an
account on Forgejo Next by logging in with any of the supported external
authentication providers. Currently supported providers are
Codeberg.org, GitHub.com, GitLab.com, Gitea.com, and try.gitea.io.
After creating your account, you can set a password for local
authentication on next.forgejo.org.
Please make sure you have a mirror or backup of any important data uploaded
to Forgejo Next! We try to avoid breaking things, but this instance is
running potentially unstable code, so don't use it as your only storage for
irreplacable valuable data.
The Forgejo Next service is a collaborative effort. Provided by Codeberg
and managed by the Forgejo community, a selection of Forgejo contributors
have administrative access to the instance and all user data in addition
to Codeberg's administrators. Please do not use private repositories on
Forgejo Next to store highly sensitive secrets.
<!-- TODO: Add link to list of people who have access -->
<!-- TODO: Coordinate with Codeberg to work out allowed content for this instance and add a section about it. -->

1
docs/user/index.md
View file

@ -10,6 +10,7 @@ involved in running it on their machines.
- [The Basics of Issue Tracking](./issue-tracking-basics/)
- [Integrated Wiki](./wiki/)
- [Email Settings](./email-settings/)
- [Forgejo Next](./forgejo-next/)
- Collaborating with Others
- [Projects / Kanban boards](./project/)
- [Pull requests and Git flow](https://docs.codeberg.org/collaborating/pull-requests-and-git-flow/)