Skip to content

Commit

Permalink
Update instructions for upload passwords
Browse files Browse the repository at this point in the history
  • Loading branch information
hinerm committed Jul 26, 2021
1 parent 23f7392 commit 20bfbf8
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 20 deletions.
5 changes: 2 additions & 3 deletions _pages/update-sites/automatic-uploads.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,7 @@ nav-title: Automatic Uploads
- An open-source project hosted on [GitHub](/develop/github)
- Logging in to [Travis CI](https://travis-ci.org/auth) with your corresponding GitHub account
- [Travis command line tools](https://github.com/travis-ci/travis.rb#installation)
- An [account on this wiki](Special_CreateAccount)
- An [initialized upload password](Special_ChangeUploadPassword). (**NOTE** - *not* necessarily the same as your Wiki password)
- An [initialized upload password](/update-sites/setup#add-your-personal-update-sit).

# Additional resources

Expand Down Expand Up @@ -95,7 +94,7 @@ by your informations.

## Encrypting your password

To upload to your wiki update site, you will need to provide Travis CI with a `WIKI_UPLOAD_PASS` environment variable, which should evaluate to the [upload password](Special_ChangeUploadPassword) of the Wiki account performing the upload. To do so securely, follow the instructions on the [encrypting environment variables](https://docs.travis-ci.com/user/environment-variables/#Encrypting-Variables-Using-a-Public-Key).
To upload to your wiki update site, you will need to provide Travis CI with a `WIKI_UPLOAD_PASS` environment variable, which should evaluate to the [upload password](/update-sites/setup#add-your-personal-update-site) of the Wiki account performing the upload. To do so securely, follow the instructions on the [encrypting environment variables](https://docs.travis-ci.com/user/environment-variables/#Encrypting-Variables-Using-a-Public-Key).

Note that when you run:

Expand Down
3 changes: 1 addition & 2 deletions _pages/update-sites/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ Please see the [Personal Update Site Terms of Service](/update-sites/tos) page.

## How do I set a password for my personal update site?

Use [this page](Special_ChangeUploadPassword) to set a password for *uploading* content.
Please see the instructions on the [Personal Update Sites](/update-sites/setup#add-your-personal-update-site) page.

If you want to restrict which users can *access* your update site, please note that the [Personal Update Sites](/update-sites/setup#add-your-personal-update-site) service is only intended for freely available plugins. To restrict user access, you will need to host the update site yourself, sharing the URL only with your customers. Implementing an authentication scheme on top of an ImageJ update site is outside the scope of ImageJ—consider using something like [OAuth](http://oauth.net/).

Expand Down Expand Up @@ -93,5 +93,4 @@ The *View changes* option is helpful to identify what downloads are pending. Onc

Other options to check if still not resolved:

- Be sure to set your upload password for your currently logged-in wiki account. Just click [Set/change upload password](Special_ChangeUploadPassword) under the MORE TOOLS section at the bottom of any wiki page.
- Be sure that under "Manage update sites" that your credentials are inserted for your update site. See [Uploading files to your update site](/update-sites/setup#uploading-files-to-your-update-site) on the ImageJ wiki to double-check how to do this.
29 changes: 14 additions & 15 deletions _pages/update-sites/setup.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
---
mediawiki: How_to_set_up_and_populate_an_update_site
title: How to set up and populate an update site
section: Extend:Update Sites
project: /software/imagej2
Expand All @@ -17,41 +16,41 @@ See the [Distribution](/contribute/distributing) page for a discussion of the be

## Add your personal update site

{% include notice icon="warning" content='Please note that since the [Wiki relaunch](https://imagej.net/events/wiki-grand-opening/), personal update sites are no longer hosted through the ImageJ Wiki. Existing upload credentials are unaffected - but the process for creating/updating credentials has changed.' %}

By far the easiest method to provide your macros, scripts and plugins to other users, letting them keep up-to-date in the most convenient manner, is to set up your *personal update site*.

A *personal update site* is hosted on https://sites.imagej.net/<imagej-wiki-account>. If you do not have an ImageJ Wiki account yet, no need to worry, you can register one while setting up your update site.
A *personal update site* is hosted on https://sites.imagej.net/<update-site-name>. Uploading to a personal update site requires upload credentials (see below).

{% include notice icon="info" content='There are some minimal *Terms of Service* for personal update sites. See the [Personal Update Site Terms of Service](/update-sites/tos) for details.' %}

First of all, create a wiki account on https://imagej.net.
First of all, please use [this thread on the imagej.sc forum](https://forum.image.sc/t/requests-for-creating-imagej-update-sites/40051/) to request a new upload account and/or new update site. You can also request the addition or removal of uploader permissions to a particular site, or request a password reset.

Please note, that the password for the corresponding update site is NOT the one for your wiki account. In order to set your update site password, use the link at the bottom of the wiki or click [here](Special_ChangeUploadPassword).
If you need to create a new upload account as part of this process, your password will be PM'd to you by a forum admin.

start the updater with {% include bc path='Help | Update'%} and click on the *Manage update sites* button:
To start using your update site, in ImageJ start the updater with {% include bc path='Help | Update'%} and click on the *Manage update sites* button:

<img src="/media/mamed-3.jpg" width="770"/>

### Specifying your existing ImageJ Wiki account
### Specifying your upload account

Enter the name of that account and click *OK*:
Click the *Add my site* button, enter account name and click *OK*. This will add a new entry with the appropriate URL and host configuration. It will also validate that the update site actually exists.

<img src="/media/update-sites/personal-update-site-1.png" width="770"/>

If your upload password (separate from your wiki password) was not initialized, you will then be asked to provide your wiki password, which will be used to initialize your upload password. The two passwords can differ. This can be source of confusion during setting up of the update.

You can also manually [change or initialize your upload password](Special_ChangeUploadPassword).
When you start the upload process you will be prompted for your password.

### Dedicated plugin update sites

Rather than having a single update site for many plugins, it is highly advised to set up dedicated update sites for each plugin that could be of interest to the community.
Such dedicated update site can have a more intuitive name.
A given user/wiki account can own several update sites. To request a new update site for your user account, post your request on the forum (see [related post](https://forum.image.sc/t/distributing-several-update-sites/21219/2?u=lthomas)), or on the [ImageJ Gitter](https://gitter.im/imagej/imagej).
A given upload account can own several update sites. To request a new update site for your user account, post your request on the forum (see [related post](https://forum.image.sc/t/distributing-several-update-sites/21219/2?u=lthomas)), or on the [ImageJ Gitter](https://gitter.im/imagej/imagej).

## Group update site

In addition to [personal update sites](/update-sites/setup#add-your-personal-update-site), it is possible for groups of people to share an update site.

To create such an update site, post on the [Image.sc Forum](https://forum.image.sc/tags/imagej), or in the [imagej Gitter channel](https://gitter.im/imagej/imagej), requesting the creation of the site on `sites.imagej.net`, including the desired name of the site, as well as the wiki usernames to be granted upload permission to the group update site. An administrator will then create the site skeleton and grant those users upload permission to the new site.
To create such an update site, post on the [Image.sc Forum](https://forum.image.sc/tags/imagej), or in the [imagej Gitter channel](https://gitter.im/imagej/imagej), requesting the creation of the site on `sites.imagej.net`, including the desired name of the site, as well as the upload users to be granted upload permission to the group update site. An administrator will then create the site skeleton and grant those users upload permission to the new site.

## Adding an update site on your own server

Expand All @@ -72,7 +71,7 @@ The *upload information* depends on the protocol available for uploading:

In case you want to use an SFTP/SSH server, it must have an empty, public web accessible folder where you intend to publish your updates. The ImageJ updater will not create that empty folder.

{% include aside title="A note about SSH and `known_hosts`" content='For ImageJ to connect to your server over SSH, you must have configured your SSH credentials as normal—i.e.: `$HOME/.ssh/known_hosts` must contain the host key, and optionally `$HOME/.ssh/config` may contain the host configuration/credentials. We recommend that the given host be specified in `$HOME/.ssh/config` and equipped with a private key.
{% include notice icon="tip" content='**A note about SSH and `known_hosts`:** For ImageJ to connect to your server over SSH, you must have configured your SSH credentials as normal—i.e.: `$HOME/.ssh/known_hosts` must contain the host key, and optionally `$HOME/.ssh/config` may contain the host configuration/credentials. We recommend that the given host be specified in `$HOME/.ssh/config` and equipped with a private key.

Note that you need to connect with command-line ssh first, to record the finger-print of the host. It might be necessary to call `ssh-keyscan test.imagej.net >> $HOME/.ssh/known_hosts` to ensure the correctly formatted key appears in your configuration file. There is an issue with newer SSH servers offering host keys in `ecdsa-sha2-nistp256` format, but the [JSch](http://www.jcraft.com/jsch/) library wanting them in `ssh-rsa` format instead. If you receive the error `com.jcraft.jsch.JSchException: UnknownHostKey` then you might be bitten by this discrepancy; try using the `ssh-keyscan` invocation above. If you still have trouble, please write to the [Image.sc Forum](https://forum.image.sc/) to troubleshoot further.' %}

Expand Down Expand Up @@ -102,7 +101,7 @@ First, start the [updater](/plugins/updater):
Click on the *Manage update sites* button and verify:

- Your update site is present and enabled
- The *Host* column of your update site contains your user name, in the form: `webdav:`<WikiUsername>
- The *Host* column of your update site contains your user name, in the form: `webdav:`<UploadUsername>

For example:

Expand Down Expand Up @@ -130,7 +129,7 @@ Select the file to upload, click under the *Stats/Action* column, or right-click

<img src="/media/update-sites/upload-to-update-site.png" width="770"/>

{% include notice icon="info" content='The *Upload to <update site name>* option is only available if you entered your [wiki credentials](#start-the-updater-and-check-your-update-site) and no other changes are pending. Be aware that the password for the update site [*is not* your Wiki password](/update-sites/faq#how-do-i-set-a-password-for-my-personal-update-site). This is to avoid potentially corrupting your ImageJ installation. If the Upload option is not available, select the *View changes* view and resolve any pending changes - e.g. by updating or reverting to **Keep as-is**.' %}
{% include notice icon="info" content='The *Upload to <update site name>* option is only available if you entered your [upload credentials](#start-the-updater-and-check-your-update-site) and no other changes are pending. This is to avoid potentially corrupting your ImageJ installation. If the Upload option is not available, select the *View changes* view and resolve any pending changes - e.g. by updating or reverting to **Keep as-is**.' %}

### Modifying Dependencies

Expand Down

0 comments on commit 20bfbf8

Please sign in to comment.