Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README possibly misleading on repository visibility #165

Closed
sylph1o opened this issue Oct 12, 2022 · 2 comments · Fixed by #166
Closed

README possibly misleading on repository visibility #165

sylph1o opened this issue Oct 12, 2022 · 2 comments · Fixed by #166

Comments

@sylph1o
Copy link

sylph1o commented Oct 12, 2022

While reading the README for the first time, this comment in the configuration example lead me to believe that any user would be able to see all repositories, i.e. soft-serve manages write access but not read access. That would seriously limit my use for soft-serve, which I find otherwise very interesting.

Exploring further lead me to issue #80, which suggests that a repository configured as private is only visible to users who have it their collab-repos. That would be the read-access management that I thought was missing. If this is true, then the README is misleading (at least, it misled me), to the detriment of soft-serve.

@aymanbagabas
Copy link
Member

While reading the README for the first time, this comment in the configuration example lead me to believe that any user would be able to see all repositories, i.e. soft-serve manages write access but not read access. That would seriously limit my use for soft-serve, which I find otherwise very interesting.

Exploring further lead me to issue #80, which suggests that a repository configured as private is only visible to users who have it their collab-repos. That would be the read-access management that I thought was missing. If this is true, then the README is misleading (at least, it misled me), to the detriment of soft-serve.

Good catch @sylph1o! The readme is indeed misleading.

Repositories configured as private are only accessible by admins and collab-users. Regular users can access all public repositories based on the anon-access config property.

aymanbagabas added a commit that referenced this issue Oct 13, 2022
Private repos can be accessed by admins and collab users. All other
users can read public repos based on the anon-access setting.

Fixes: #165
aymanbagabas added a commit that referenced this issue Oct 13, 2022
Private repos can be accessed by admins and collab users. All other
users can read public repos based on the anon-access setting.

Fixes: #165
@sylph1o
Copy link
Author

sylph1o commented Oct 13, 2022

Thanks for the quick reaction and the clarification! I look forward to trying soft-serve, it looks already very nice, and promising 😃

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants