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

Documentation not clear on external server access #1168

Open
zounp opened this issue Jun 2, 2021 · 2 comments
Open

Documentation not clear on external server access #1168

zounp opened this issue Jun 2, 2021 · 2 comments

Comments

@zounp
Copy link

zounp commented Jun 2, 2021

I read: "When everything works, you can get a client and start creating calendars and address books. The server only binds to localhost (is not reachable over the network) and you can log in with any user name and password. "
I do not understand this. There are clients like DAVx⁵ which can contact the server over the network. On the otherhand I read "is not reachable over the network". I am confused by this an I think it can be clearer written down here what is actually the case.

Also I read: "DAVx⁵ Enter the URL of the Radicale server (e.g. http://localhost:5232) and your user name. DAVx⁵ will show all existing calendars and address books and you can create new."
Again confused: How is this going to work. DAVx⁵ is running on an Android device. Radicale is running on a server (not being the Android device DAVx⁵ is running on). How can this work. Localhost has IP 127.x.x.x. which is not reachable from outside the server. I think this also needs clarification.

@ploink
Copy link

ploink commented Jun 15, 2021

It may be helpful to provide a link to where you read that. I found it at:
https://radicale.org/3.0.html#tutorials/simple-5-minute-setup

When everything works, you can get a client and start creating calendars and address books. The server only binds to localhost (is not reachable over the network) and you can log in with any user name and password. If Radicale fits your needs, it may be time for some basic configuration.

Everything is explained below that text, but I agree it may be a little confusing when you are new to radicale and read it for the first time.

I would perhaps rephrase it like this:

By default, the server only binds to localhost (is not reachable over the network) and you can log in with any user name and password. When everything works, you may get a local client and start creating calendars and address books. If Radicale fits your needs, it may be time for some basic configuration to support remote clients.

@zounp
Copy link
Author

zounp commented Jun 15, 2021

That would be a lot better.
Also after looking at the page again I get the impression that Radicale is meant to be used over the network hence "Server" That is also how I read it two weeks ago. Then I read the first notice of localhost. That is where the confusion starts.

To make the page more clear it might be an idea to change:
"Simple 5-minute setup" Into something like "Local setup"
and
"Basic Configuration" into something like "Remote setup"

Move "When the server is launched, open http://localhost:5232/ in your browser! You can login with any username and password." to the "Local setup" chapter and to the "Remote setup" chapter a bit changed: "When the server is launched, open http://TheIPaddressoftheServer:5232/ in your browser! You can login with any username and password."
Also I would change "server is launched" in "server is installed and running" and maybe explain how you can tell it is running without logging in. For example by running a systemctl command or looking for it in top.

Also I read "Authentication
In its default configuration Radicale doesn't check user names or passwords. If the server is reachable over a network, you should change this."
I think this is bad. Before you have changed it the Radicale server can be compromised. I think that before the server has an open network connection the username and password have to be set by the user to something safe.

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

No branches or pull requests

3 participants