forgejo/docs
31
58
Fork
You've already forked docs
249

Documenting remote data folder #193

Merged
earl-warren merged 5 commits from dbischof90/docs:pr/remote_data_folder_doc into next 2023年10月14日 19:42:42 +02:00
Contributor
Copy link

Documentation proposal for remote data mounting, following up from forgejo/forgejo#1590

Documentation proposal for remote data mounting, following up from https://codeberg.org/forgejo/forgejo/issues/1590
Small change
All checks were successful
pr / preview (pull_request) Successful in 39s
7625754ae2
dbischof90 changed title from (削除) pr/remote_data_folder_doc (削除ここまで) to Documenting remote data folder 2023年10月14日 15:31:30 +02:00
earl-warren left a comment
Copy link

Looks good. Minor suggestions and then it is good to go.

Looks good. Minor suggestions and then it is good to go.
@ -148,1 +148,4 @@
### Hosting repository data on remote storage systems
You might also mount the data and repository folder on a remote drive such as a
Contributor
Copy link

*folders

*folders
dbischof90 marked this conversation as resolved
@ -149,0 +154,4 @@
measures have to be taken in general so that the administrators can adapt this to
their individual setup. Note that the Forgejo developement team does not endorse
this method as it **can potentially lead to corrupted files depending on your setup**,
it is important that you know what you are doing here.
Contributor
Copy link

Note that the Forgejo developement team does not endorse this method as it can potentially lead to corrupted files depending on your setup, it is important that you know what you are doing here.

I think this can be left out, it is implied that the reader knows what they are doing.

> Note that the Forgejo developement team does not endorse this method as it **can potentially lead to corrupted files depending on your setup**, it is important that you know what you are doing here. I think this can be left out, it is implied that the reader knows what they are doing.
Author
Contributor
Copy link

Okay, just wanted to prevent people coming in later and complaining but you're probably right.

Okay, just wanted to prevent people coming in later and complaining but you're probably right.
dbischof90 marked this conversation as resolved
@ -149,0 +167,4 @@
```shell
[...]
/repositories *(rw,sync,no_wdelay,crossmnt,insecure,all_squash,insecure_locks,sec=sys,anonuid=1024,anongid=100)
Contributor
Copy link
/repositories	*(rw,sync,all_squash,sec=sys,anonuid=1024,anongid=100)

Unless one of the other options is a requirement rather than a configuration choice?

``` /repositories *(rw,sync,all_squash,sec=sys,anonuid=1024,anongid=100) ``` Unless one of the other options is a requirement rather than a configuration choice?
dbischof90 marked this conversation as resolved
@ -149,0 +203,4 @@
A problem is that if we create ssh keys on the server, they too will have `0777` permissions, which is prohibited by `openssh`.
It is important for all involved tools that these files not be writable by just anybody with a login, so you would get you an error if you try to use them.
Changing permissions will also not work through the chosen `all_squash` setup, which was however necessary to allow a correct ownership
mechanic on the server.
Contributor
Copy link

this paragraph should be separated, towards the end maybe? as a not about "why using the rootless image?".

this paragraph should be separated, towards the end maybe? as a not about "why using the rootless image?".
Author
Contributor
Copy link

Hmm for me it's "Problem -> Solution", Problem is while that works and solces the chown issue, ssh will act up and to solve this we take the rootless issue. Puts the motivation first and the solution afterwards.

Hmm for me it's "Problem -> Solution", Problem is while that works and solces the `chown` issue, ssh will act up and to solve this we take the rootless issue. Puts the motivation first and the solution afterwards.
Contributor
Copy link

that's a sensible approach when the focus is on the problem. I believe that in this installation guide the focus is on showing a path that will succeed. Discussing the various problems that could get in the way, while very valuable requires a lot more content, hence my suggestion.

that's a sensible approach when the focus is on the problem. I believe that in this installation guide the focus is on showing a path that will succeed. Discussing the various problems that could get in the way, while very valuable requires a lot more content, hence my suggestion.
Author
Contributor
Copy link

I changed the order a bit, let's consider that in a new review!

I changed the order a bit, let's consider that in a new review!
dbischof90 marked this conversation as resolved
@ -149,0 +208,4 @@
To circumvent this, you can use the `rootless` image, which hosts an embedded ssh folder. A possible entry in a `docker-compose` file
would look like this
```yaml
Contributor
Copy link

this is a diff rather that a yaml file?

this is a diff rather that a yaml file?
Author
Contributor
Copy link

Correct, I oriented myself on the DB sections to highlight changes over the "base config" at the top. How would you do it differently?

Correct, I oriented myself on the DB sections to highlight changes over the "base config" at the top. How would you do it differently?
Contributor
Copy link

Oh, that's a good way to do it. Could you maybe add "(this is a diff to the docker compose shown above)" or something similar?

Oh, that's a good way to do it. Could you maybe add "(this is a diff to the docker compose shown above)" or something similar?
dbischof90 marked this conversation as resolved
Review round #1 : Small changes
All checks were successful
pr / preview (pull_request) Successful in 41s
c0b49e5bcf
Review round #2
All checks were successful
pr / preview (pull_request) Successful in 42s
backport / backport (pull_request) Successful in 2s
57d2f2c96d
Sign in to join this conversation.
No reviewers
Labels
Clear labels
404
Broken links or missing content
backport/v1.19
Changes which should be backported to the v1.19 docs

Archived

backport/v1.20
Changes which should be backported to the v1.20 docs

Archived

backport/v1.21
Changes which should be backported to the v1.21 docs

Archived

backport/v10.0
Automated backport to v10.0

Archived

backport/v11.0
Automated backport to v11.0
backport/v12.0
Automated backport to v12.0

Archived

backport/v13.0
Automated backport to v13.0

Archived

backport/v14.0
Automated backport to v14.0

Archived

backport/v15.0
Automated backport to v15.0
backport/v16.0
Automated backport to v16.0
backport/v7.0
Automated backport to the v7.0 docs

Archived

backport/v8.0
Automated backport to the v8.0 docs

Archived

backport/v9.0
Automated backport to the v9.0 docs

Archived

good first issue
This issue is suitable for "drive-by contributors" wanting to contribute for the first time, and fixing it should be straightforward.
meta
Tooling and processes for maintaining the docs
new docs
Content to be added to the documentation

Archived

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
2 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/docs!193
Reference in a new issue
forgejo/docs
No description provided.
Delete branch "dbischof90/docs:pr/remote_data_folder_doc"

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?