Browse Source

add docs re: sharing source code modifications

master
james hadfield 1 year ago
parent
commit
b2c8a6543b
  1. 3
      docs/customise-client/api.md
  2. 6
      docs/customise-client/index.rst
  3. 6
      docs/server/index.rst

3
docs/customise-client/api.md

@ -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

6
docs/customise-client/index.rst

@ -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::

6
docs/server/index.rst

@ -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
======================================

Loading…
Cancel
Save