Skip to content

Missing documentation on important steps #4

Description

@cjhenck

I was able to get this up and running with outline-bots, but there were for me a few steps that were not obvious and required substantial troubleshooting. I think it would help to add these to the documentation:

  1. You need to set up URL paths for the distribution & preference apps. They are not automatic. E.g.:
    path('api/v1/', include('distribution.urls')),
    path('api/v1/', include('server.urls')),
  1. Those projects use django-rest-framework, which requires authentication. Users will need to set up that authentication to their specification or, if using the outline-bots repo, add TokenAuth both as an app and as a django-rest-framework authenticator in their settings.py
  2. To use the API, you need to set up a server through the admin console. Which fields are required? Do I need ipv4 & ipv6 addresses? How do I get the management URL (from the manager) or certificate details (by SSH'ing into the server and finding the has of it)? Obviously getting access to the server may be out of scope, but it would be helpful to point to where both details are stored. (~/shadowbox/access.txt).

It might also help to suggest users look for a "getting started with django" tutorial, though that may be obvious to anyone interested in setting this up.

Thanks for making this available!

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions