32
41
Fork
You've already forked website
52

docs: installation manual #231

Merged
earl-warren merged 9 commits from earl-warren/website:wip-install into main 2023年05月28日 15:40:06 +02:00
Contributor
Copy link

Preview: https://forgejo.codeberg.page/@pull_231/docs/v1.20/admin/installation/

Fixes: forgejo/forgejo#778

Preview: https://forgejo.codeberg.page/@pull_231/docs/v1.20/admin/installation/ Fixes: https://codeberg.org/forgejo/forgejo/issues/778
Collaborator
Copy link

Preview ready: https://forgejo.codeberg.page/@pull_231/

Preview ready: https://forgejo.codeberg.page/@pull_231/
earl-warren force-pushed wip-install from ab5b12d47d
All checks were successful
forgejo-ci/pr/woodpecker Pipeline was successful
to 22bbf14d81
All checks were successful
forgejo-ci/pr/woodpecker Pipeline was successful
2023年05月27日 19:06:52 +02:00 Compare
import from markdown
All checks were successful
forgejo-ci/pr/woodpecker Pipeline was successful
12359ee61b
trim content that are blog rather than a reference documentation
All checks were successful
forgejo-ci/pr/woodpecker Pipeline was successful
1d0c3ae2b9
earl-warren changed title from (削除) WIP: docs: installation manual (削除ここまで) to docs: installation manual 2023年05月28日 00:23:38 +02:00
earl-warren force-pushed wip-install from a3ad5df50d
All checks were successful
forgejo-ci/pr/woodpecker Pipeline was successful
to 7e60a379a1
All checks were successful
forgejo-ci/pr/woodpecker Pipeline was successful
2023年05月28日 00:30:13 +02:00 Compare
database is part of docker
All checks were successful
forgejo-ci/pr/woodpecker Pipeline was successful
b13a485aef
explain the database section
All checks were successful
forgejo-ci/pr/woodpecker Pipeline was successful
9275bfdfb7
consistently use example.com
All checks were successful
forgejo-ci/pr/woodpecker Pipeline was successful
e84a6762de
@ -0,0 +151,4 @@
## Install Forgejo and git, create git user
> **NOTE:** this guide assumes that you'll host on the server with the domain git.example.com" at the beginning.
First-time contributor
Copy link

I think the "at the beginning" was a copy&paste fail ;)

I think the "at the beginning" was a copy&paste fail ;)
Author
Contributor
Copy link

It was.

It was.
earl-warren marked this conversation as resolved
@ -0,0 +156,4 @@
First, download the Forgejo binary for your CPU architecture and maybe verify the GPG signature,
as described on [the Forgejo download page](https://forgejo.org/download/).
Next, copy the downloaded Forgejo binary to `/usr/local/bin/` (renaming it to just "forgejo")
First-time contributor
Copy link

You should describe that # foo --bar means "run command 'foo --bar' as root (or with sudo)"

You should describe that `# foo --bar` means "run command 'foo --bar' as root (or with sudo)"
earl-warren marked this conversation as resolved
@ -0,0 +252,4 @@
on the dashboard (if you created an administrator account) or at the login/register screen, where you
can create an account to then get to the dashboard.
So far, so good, but we're not quite done yet - some manual configuration in the app.ini is needed!
First-time contributor
Copy link

"is needed" - well, in the general case, maybe not.
most of it is mostly relevant if you want to host big repos, esp. ones with LFS files - and the e-mail/sendmail part is only relevant if you have a working /usr/sbin/sendmail on your server (which I could assume in my blog post because I described setting up dma, but here it's possible that people just want to use SMTP directly)

"is needed" - well, in the general case, maybe not. most of it is mostly relevant if you want to host big repos, esp. ones with LFS files - and the e-mail/sendmail part is only relevant if you have a working `/usr/sbin/sendmail` on your server (which I could assume in my blog post because I described setting up dma, but here it's possible that people just want to use SMTP directly)
Author
Contributor
Copy link

I think it is fine and people will figure out for themselves if they want that or not. It is sensible in the context of Forgejo to keep that part because there is a focus on scaling.

I think it is fine and people will figure out for themselves if they want that or not. It is sensible in the context of Forgejo to keep that part because there is a focus on scaling.
First-time contributor
Copy link

ok

ok
@ -0,0 +324,4 @@
- By default LFS files are stored in the filesystem, in `/var/lib/forgejo/data/lfs`.
In the `[lfs]` section you can change the `PATH = ...` line to store elsewhere, but you can also
configure Forgejo to store the files in an S3-like Object-Storage.
- Enable sending E-Mails with sendmail by changing the `[mailer]` section like this:
First-time contributor
Copy link

"If you want to use the systemwide sendmail, ..."

"If you want to use the systemwide `sendmail`, ..."
Author
Contributor
Copy link

That was my preferred options on my first setup too.

That was my preferred options on my first setup too.
earl-warren marked this conversation as resolved
First-time contributor
Copy link

By the way, as this is based on my (not yet properly published) blogpost that will be hosted at https://blog.gibson.sh : I am ok with these parts of my blogpost (and maybe also the one about nginx; if you find others relevant, feel free to ask) being used for the forgejo documentation under CC-BY-SA license.

By the way, as this is based on my (not yet properly published) blogpost that will be hosted at https://blog.gibson.sh : I am ok with these parts of my blogpost (and maybe also the one about nginx; if you find others relevant, feel free to ask) being used for the forgejo documentation under CC-BY-SA license.
@ -0,0 +225,4 @@
## Forgejos web-based configuration
You should now be able to access Forgejo in your local web browser, so open http://git.example.com/.
First-time contributor
Copy link

http://git.example.com:3000/

Missed this in my review: This might be a good place to mention that users could either configure an nginx reverse proxy that listens on port 80, or after the initial configuration change the port in the app.ini to 80

http://git.example.com:3000/ Missed this in my review: This might be a good place to mention that users could either configure an nginx reverse proxy that listens on port 80, or after the initial configuration change the port in the app.ini to 80
earl-warren marked this conversation as resolved
First-time contributor
Copy link

This doesn't have to be part of this PR of course, but you could add my nginx chapter to https://forgejo.org/docs/latest/admin/reverse-proxy/

And you could add "Git LFS docs" that contain my chapter on using S3-like minio object storage (and migrating from local storage to object storage and back)

And I guess some place (could be this installation manual, could be an extra page) could mention how to setup SSL/TLS for https support (maybe both with Forgejo directly, or when terminating the connection in nginx - in that case you could probably just link to nginx https documentation and otherwise only describe the Forgejo-specific parts, like probably setting ROOT_URL = https://git.example.com/

This doesn't have to be part of this PR of course, but you could add my nginx chapter to https://forgejo.org/docs/latest/admin/reverse-proxy/ And you could add "Git LFS docs" that contain my chapter on using S3-like minio object storage (and migrating from local storage to object storage and back) And I guess some place (could be this installation manual, could be an extra page) could mention how to setup SSL/TLS for https support (maybe both with Forgejo directly, or when terminating the connection in nginx - in that case you could probably just link to nginx https documentation and otherwise only describe the Forgejo-specific parts, like probably setting `ROOT_URL = https://git.example.com/`
update the source URL
All checks were successful
forgejo-ci/pr/woodpecker Pipeline was successful
bf2d58ebd8
Author
Contributor
Copy link

By the way, as this is based on my (not yet properly published) blogpost that will be hosted at https://blog.gibson.sh : I am ok with these parts of my blogpost (and maybe also the one about nginx; if you find others relevant, feel free to ask) being used for the forgejo documentation under CC-BY-SA license.

I changed the reference URL to be github.com/DanielGibson/DanielGibson.github.io@58362695f7/content/post/setup-vps-with-wireguard-and-forgejo.md

Thanks for allowing the re-use of part of the content.

> By the way, as this is based on my (not yet properly published) blogpost that will be hosted at https://blog.gibson.sh : I am ok with these parts of my blogpost (and maybe also the one about nginx; if you find others relevant, feel free to ask) being used for the forgejo documentation under CC-BY-SA license. I changed the reference URL to be https://github.com/DanielGibson/DanielGibson.github.io/blob/58362695f743a545d2530508ce42d5fe1eea84a9/content/post/setup-vps-with-wireguard-and-forgejo.md Thanks for allowing the re-use of part of the content.
Author
Contributor
Copy link

This doesn't have to be part of this PR of course, but you could add my nginx chapter to https://forgejo.org/docs/latest/admin/reverse-proxy/

Added as a separate issue so it is not forgotten #232

And you could add "Git LFS docs" that contain my chapter on using S3-like minio object storage (and migrating from local storage to object storage and back)

And here #233

And I guess some place (could be this installation manual, could be an extra page) could mention how to setup SSL/TLS for https support (maybe both with Forgejo directly, or when terminating the connection in nginx - in that case you could probably just link to nginx https documentation and otherwise only describe the Forgejo-specific parts, like probably setting ROOT_URL = https://git.example.com/

And here #234

> This doesn't have to be part of this PR of course, but you could add my nginx chapter to https://forgejo.org/docs/latest/admin/reverse-proxy/ Added as a separate issue so it is not forgotten https://codeberg.org/forgejo/website/issues/232 > And you could add "Git LFS docs" that contain my chapter on using S3-like minio object storage (and migrating from local storage to object storage and back) And here https://codeberg.org/forgejo/website/issues/233 > And I guess some place (could be this installation manual, could be an extra page) could mention how to setup SSL/TLS for https support (maybe both with Forgejo directly, or when terminating the connection in nginx - in that case you could probably just link to nginx https documentation and otherwise only describe the Forgejo-specific parts, like probably setting `ROOT_URL = https://git.example.com/` And here https://codeberg.org/forgejo/website/issues/234
Ghost approved these changes 2023年05月28日 08:54:34 +02:00
address review comments from Daniel Gibson
All checks were successful
forgejo-ci/pr/woodpecker Pipeline was successful
2996df44db
earl-warren deleted branch wip-install 2023年05月28日 15:40:06 +02:00
Sign in to join this conversation.
No reviewers
Labels
Clear labels
404
Broken links or missing content
Accessibility
Accessibility
Blog post
Documentation
Forgejo Documentation
Internationalisation
i18n and l10n
User research - Accessibility
Requires input about accessibility features, likely involves user testing.
User research - Blocked
Do not pick as-is! We are happy if you can help, but please coordinate with ongoing redesign in this area.
User research - Community
Community features, such as discovering other people's work or otherwise feeling welcome on a Forgejo instance.
User research - Config (instance)
Instance-wide configuration, authentication and other admin-only needs.
User research - Errors
How to deal with errors in the application and write helpful error messages.
User research - Filters
How filter and search is being worked with.
User research - Future backlog
The issue might be inspiring for future design work.
User research - Git workflow
AGit, fork-based and new Git workflow, PR creation etc
User research - Labels
Active research about Labels
User research - Moderation
Moderation Featuers for Admins are undergoing active User Research
User research - Needs input
Use this label to let the User Research team know their input is requested.
User research - Notifications/Dashboard
Research on how users should know what to do next.
User research - Rendering
Text rendering, markup languages etc
User research - Repo creation
Active research about the New Repo dialog.
User research - Repo units
The repo sections, disabling them and the "Add more" button.
User research - Security
User research - Settings (in-app)
How to structure in-app settings in the future?
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
4 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
forgejo/website!231
Reference in a new issue
forgejo/website
No description provided.
Delete branch "earl-warren/website:wip-install"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?