Skip to content

Commit

Permalink
Update documentation on hosted update sites
Browse files Browse the repository at this point in the history
They are not really "personal" anymore, because they aren't tied to
wiki/GitHub accounts. You just request a named update site, along with
the users who should have upload access, and the admins create it.
So I changed the docs to call them "hosted update sites" now.
  • Loading branch information
ctrueden committed Jan 31, 2022
1 parent d6282cc commit b2b031f
Show file tree
Hide file tree
Showing 10 changed files with 44 additions and 47 deletions.
2 changes: 1 addition & 1 deletion _pages/contribute/distributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ The first goal is to get your extension into the hands of users.
</td>
<td style="background: #dfd; vertical-align: top">
<ul>
<li> You do not need server space to host your extensions; you can use a <b><a href="/update-sites/setup">personal update site</a></b> hosted on the ImageJ website.</li>
<li> You do not need server space to host your extensions; you can use a <b><a href="/update-sites/setup">hosted update site</a></b> on `sites.imagej.net`.</li>
<li> Alternately, you can retain full control by hosting your update site yourself.</li>
<li> Users are notified of updates without needing to check proactively.</li>
<li> The updater manages dependencies for you.</li>
Expand Down
4 changes: 2 additions & 2 deletions _pages/develop/releasing.md
Original file line number Diff line number Diff line change
Expand Up @@ -197,9 +197,9 @@ component must then be *uploaded* to an ImageJ [update site](/update-sites).

### External update sites

An update site can be hosted anywhere, though the ImageJ web server at http://sites.imagej.net/ offers a [personal update site](/update-sites/setup#add-your-personal-update-site) service.
An update site can be hosted anywhere, although `sites.imagej.net` provides a [hosted update site](/update-sites/setup#creating-a-hosted-update-site) service.

See the **[distribution](/contribute/distributing)** page for a discussion of pros and cons of distributing your plugin on a core versus a personal update site.
See the **[distribution](/contribute/distributing)** page for a discussion of pros and cons of distributing your plugin on a core versus a separate update site.

If you do manage [your own update site](/update-sites/setup), you can upload your release yourself.

Expand Down
4 changes: 2 additions & 2 deletions _pages/news/2013-09-27-personal-update-sites.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@ The feature is so popular that we worked hard to allow for [3rd-party update sit

But this just changed.

For a couple of weeks now, the updater supports [personal update sites](/update-sites/setup#add-your-personal-update-site), the perfect way for **every** Fiji/ImageJ user to share their macros, scripts and plugins. Thanks to [LOCI at UW-Madison](http://loci.wisc.edu/) who host the personal update sites, everybody who wants to distribute their macros, scripts and/or plugins can do so within five minutes.
For a couple of weeks now, the updater supports [personal update sites](/update-sites/setup#creating-a-hosted-update-site), the perfect way for **every** Fiji/ImageJ user to share their macros, scripts and plugins. Thanks to [LOCI at UW-Madison](http://loci.wisc.edu/) who host the personal update sites, everybody who wants to distribute their macros, scripts and/or plugins can do so within five minutes.

From now on, there is no excuse anymore for articles demonstrating or using ImageJ macros or plugins... it is too easy to set up an update site and upload those macros and plugins...

[Find out how...](/update-sites/setup#add-your-personal-update-site)
[Find out how...](/update-sites/setup#creating-a-hosted-update-site)


2 changes: 1 addition & 1 deletion _pages/news/2014-06-04-imagej-2-0-0-release-candidate.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The [Fiji](/software/fiji) distribution of ImageJ has bundled ImageJ2 for quite
ImageJ2 provides a wealth of new features and capabilities:

- The ImageJ Updater makes it simple to keep your ImageJ up to date, and to add new plugins by enabling additional [Update Sites](/update-sites).
- The ImageJ Updater also makes it simple to publish your own tools based on ImageJ, via [Personal Update Sites](/update-sites/setup#add-your-personal-update-site).
- The ImageJ Updater also makes it simple to publish your own tools based on ImageJ, via [Personal Update Sites](/update-sites/setup#creating-a-hosted-update-site).
- New and enhanced file format support via the SCIFIO library. There is no need to call a special SCIFIO plugin; it works with commands like {% include bc path="File | Open" %} automatically. Additional import options are available via the {% include bc path="File | Import | Image..." %} command. See the [SCIFIO](/libs/scifio) page of the ImageJ wiki for further details. {% include img align="right" src="/media/news/imagej2-options.png" width="270px" %}
- New commands:
- {% include bc path="Plugins | Debug | Dump Stack" %} for debugging when things {% include wikipedia title='Hang (computing)' text='hang'%}.
Expand Down
2 changes: 1 addition & 1 deletion _pages/plugins/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ The ImageJ [Updater](/plugins/updater) is the best way to install and update plu

### Installing plugins manually

If the plugin you want is not distributed via an ImageJ update site, please encourage the plugin's maintainer to do so! Anyone can create a [personal update site](/update-sites/setup#add-your-personal-update-site) as well as additional dedicated update sites (for a particular plugin) hosted on [sites.imagej.net](http://sites.imagej.net/), to easily share and maintain updated plugins.
If the plugin you want is not distributed via an ImageJ update site, please encourage the plugin's maintainer to do so! Anyone can create a [hosted update site](/update-sites/setup#creating-a-hosted-update-site) on [sites.imagej.net](http://sites.imagej.net/), to easily share and maintain updated plugins.

In the meantime, to install a plugin manually, follow the plugin's installation instructions, if any. The plugin will consist of one or more files which must be downloaded and (typically) placed in ImageJ's `plugins` folder:

Expand Down
12 changes: 6 additions & 6 deletions _pages/update-sites/automatic-uploads.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,15 @@ nav-links: true
nav-title: Automatic Uploads
---

{% include notice icon="info" content='This guide is intended for maintaining non-core update sites by automating builds with [GitHub Actions](https://docs.github.com/en/actions) or [Travis CI](https://travis-ci.org/).
{% include notice icon="info" content='This guide is intended for maintaining non-core update sites by automating builds with [GitHub Actions](https://docs.github.com/en/actions) or [Travis CI](https://travis-ci.com/).
- The [core update sites](/update-sites/core-uploads) are updated manually or automatically. Automated update is performed with [GitHub Actions](https://docs.github.com/en/actions) since July 2021, before that [Travis CI](/develop/travis) was used.
- GitHub Actions and Travis CI are useful because they can freely build any open source project with minimal effort.' %}

# GitHub Actions
## Requirements

- An open-source project hosted on [GitHub](/develop/github)
- An [initialized upload password](/update-sites/setup#add-your-personal-update-sit).
- An [initialized upload password](/update-sites/setup#creating-a-hosted-update-site).

## Additional resources

Expand Down Expand Up @@ -66,7 +66,7 @@ Don't forget to replace the `WIKI_USER` and `UPDATE_SITE` variables by your info

### Encrypting your password

To upload to your wiki update site, you will need to provide GitHub Actions with a `UPDATE_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 [creating encrypted secrets for a repository](https://docs.github.com/en/actions/reference/encrypted-secrets#creating-encrypted-secrets-for-a-repository).
To upload to your wiki update site, you will need to provide GitHub Actions with a `UPDATE_PASS` environment variable, which should evaluate to the [upload password](/update-sites/setup#creating-a-hosted-update-site) of the Wiki account performing the upload. To do so securely, follow the instructions on [creating encrypted secrets for a repository](https://docs.github.com/en/actions/reference/encrypted-secrets#creating-encrypted-secrets-for-a-repository).

### Non-Mavenized Files

Expand Down Expand Up @@ -94,9 +94,9 @@ This is also true if you have custom scripts, macros, etc... if these files are
## Requirements

- An open-source project hosted on [GitHub](/develop/github)
- Logging in to [Travis CI](https://travis-ci.org/auth) with your corresponding GitHub account
- Logging in to [Travis CI](https://travis-ci.com/) with your corresponding GitHub account
- [Travis command line tools](https://github.com/travis-ci/travis.rb#installation)
- An [initialized upload password](/update-sites/setup#add-your-personal-update-sit).
- An [initialized upload password](/update-sites/setup#creating-a-hosted-update-site).

## Additional resources

Expand Down Expand Up @@ -174,7 +174,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](/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).
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#creating-a-hosted-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
20 changes: 10 additions & 10 deletions _pages/update-sites/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,26 +52,26 @@ If the file is not hosted by any other active update site you need to tell the u

Deleting a file from the history is strongly not recommended, but if you *must* do so (e.g., for legal or privacy reasons):

- If you using a [personal update site](/update-sites/setup#add-your-personal-update-site), then [contact an ImageJ administrator](/discuss) to have the offending file(s) removed.
- If you are hosting your own update site, then you must delete all versions of the file from the file system, *and* edit the *db.xml.gz* file to remove the *<plugin>* entry as well as any *<dependency>* elements in other entries which reference it.
- If you using a [hosted update site](/update-sites/setup#creating-a-hosted-update-site), then [contact an administrator](/discuss) to have the offending file(s) removed.
- If you are hosting your own update site, then you must delete all versions of the file from the file system, *and* edit the `db.xml.gz` file to remove the `<plugin>` entry as well as any `<dependency>` elements in other entries which reference it.

## What are the Terms of Service for personal update sites?
## What are the Terms of Service for hosted update sites?

Please see the [Personal Update Site Terms of Service](/update-sites/tos) page.
Please see the [Hosted Update Site Terms of Service](/update-sites/tos) page.

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

Please see the instructions on the [Personal Update Sites](/update-sites/setup#add-your-personal-update-site) page.
Please see the instructions on the [Hosted Update Sites](/update-sites/setup#creating-a-hosted-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/).
If you want to restrict which users can *access* your update site, please note that the [Hosted Update Sites](/update-sites/setup#creating-a-hosted-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/).

## How do I delete my personal update site?
## How do I delete my hosted update site?

If you want to completely remove your update site, [contact an ImageJ administrator](/discuss) to have the site removed.
If you want to completely remove your update site, [contact an administrator](/discuss) to have the site removed.

## Can I manipulate the files on my update site directly? (E.g., via WebDAV?)

Please don't! Update sites are intended to be accessed *only* via ImageJ's [Updater](/plugins/updater). There is important metadata in the *db.xml.gz* file which *must* be kept in sync with the files in the directory structure. Otherwise, your update site will stop working properly.
Please don't! Update sites are intended to be accessed *only* via ImageJ2's [Updater](/plugins/updater). There is important metadata in the `db.xml.gz` file which *must* be kept in sync with the files in the directory structure. Otherwise, your update site will stop working properly.

## Why don't I have an upload option?

Expand Down
2 changes: 1 addition & 1 deletion _pages/update-sites/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ if not updateService.getUpdateSite("Fiji-Legacy").isActive():

## Creating your own update site

Anyone can share their extensions ([plugins](/plugins), [scripts](/scripting), etc.) by [creating their own update site](/update-sites/setup). You can use ImageJ2's [personal update site](/update-sites/setup#add-your-personal-update-site) service (hosted on the [ImageJ2 web server](http://sites.imagej.net/)), or host it on your own server.
Anyone can share their extensions ([plugins](/plugins), [scripts](/scripting), etc.) by [creating their own update site](/update-sites/setup). You can use ImageJ2's [hosted update site](/update-sites/setup#creating-a-hosted-update-site) service, or host it on your own server.

## Frequently asked questions

Expand Down
Loading

0 comments on commit b2b031f

Please sign in to comment.