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

Adding undocumented option to cockpit.file #70

Closed
wants to merge 1 commit into from
Closed

Adding undocumented option to cockpit.file #70

wants to merge 1 commit into from

Conversation

machadotiago
Copy link

@machadotiago machadotiago commented Jun 14, 2017

It's also possible to use superuser with cockpit.file but it was not
documented in the Cockpit Guide as mentioned here: #69

It's also possible to use superuser with cockpit.fail but it was not
doccumented in the Cockpit Guide
@machadotiago machadotiago changed the title Adding undocumented option to cockpit.fail Adding undocumented option to cockpit.file Jun 14, 2017
@mvollmer mvollmer self-assigned this Jun 15, 2017
@mvollmer
Copy link
Member

Thanks!

This repo is unfortunately not the place to fix this. The sources for the cockpit guide are here: https://github.com/cockpit-project/cockpit/blob/master/doc/guide/cockpit-file.xml

In fact, all options accepted by cockpit.channel are also possible with cockpit.file. The interesting ones are superuser and host. (payload will be determined by cockpit.file, of course, and binary is already documented.)

Could you open a pull request for https://github.com/cockpit-project/cockpit?

@mvollmer
Copy link
Member

In fact, all options accepted by cockpit.channel are also possible with cockpit.file. The interesting ones are superuser and host. (payload will be determined by cockpit.file, of course, and binary is already documented.)

(Ahh, you knew this. Sorry for the noise.)

@@ -84,6 +85,12 @@
<p>It is not an error when the file does not exist. In this case, the
<code class="code">done()</code> callback will be called with a <code class="code">null</code>
value for <code class="code">content</code> and <code class="code">tag</code> is <code class="code">"-"</code>.</p>
<p>Set <code class="code">superuser</code> to "require" for reading or writing a file as root instead of the logged
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should just say that superuser is also allowed and link to the docs for cockpit.channel.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fair enough, I will change the text and make the pull request to the correct repo.
Thanks !

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 this pull request may close these issues.

2 participants