Skip to content

Commit

Permalink
add docs re: sharing source code modifications
Browse files Browse the repository at this point in the history
  • Loading branch information
jameshadfield committed Jan 11, 2021
1 parent a466dac commit b2c8a65
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 0 deletions.
3 changes: 3 additions & 0 deletions docs/customise-client/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,9 @@ A useful reference may be the [customisation JSON file](https://github.com/nexts
* `googleAnalyticsKey` You can specify a Google Analytics key to enable (some) analytics functionality. More documentation to come.
* `serverAddress` Specify the address / prefix which the auspice client uses for API requests.


> Please remember to make any modifications, including customisations described here, publicly available. See [the previous page](./index.rst) for more details.
---

### Sidebar Theme
Expand Down
6 changes: 6 additions & 0 deletions docs/customise-client/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,12 @@ This is achieved by providing a JSON at build time to Auspice which defines the

See the `client customisation API <api.html>`_ for the available options.

AGPL Source Code Requirement
============================

Auspice is distributed under `AGPL 3.0 <https://www.gnu.org/licenses/agpl-3.0.en.html>`_.
Any modifications made to the auspice source code, including build-time customisations as described here, must be made publicly available.
We ask that the "Powered by Nextstrain" text and link, rendered below the data visualisations, be maintained in all customised versions of auspice, in keeping with the spirit of scientific citations.


.. toctree::
Expand Down
6 changes: 6 additions & 0 deletions docs/server/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,12 @@ You can customise the default Auspice server by supplying your own handlers for
See `the API documentation <../server/api.html#suppling-custom-handlers-to-the-auspice-server>`_ for how to define these and provide them to `auspice view`.


AGPL Source Code Requirement
============================

Auspice is distributed under `AGPL 3.0 <https://www.gnu.org/licenses/agpl-3.0.en.html>`_.
Any modifications made to the auspice source code, including the auspice server, must be made publicly available.

Writing Your Own Custom Server
======================================

Expand Down

0 comments on commit b2c8a65

Please sign in to comment.