-
Notifications
You must be signed in to change notification settings - Fork 38
Implementation
This page has been replaced by this docs.hypha.app: https://docs.hypha.app/contributing/implementationdetails
Media is encouraged to be split into two distinct storage locations. A Public and a Private location, applicant media should exist only in the Private location. This is for two reasons:
-
This separates the site media, which is served publicly with no authentication, from the Applicant media, which has permissions checks, it reduces the risk of a miss-configured storage exposing the Applicant data.
-
Maintains separation between the two halves of the platform, Apply and Public.
Media should also be served from a view that inherits from the PrivateMediaView which will confirm that the file isn't made public and can be configured to return the file object from an authenticated view.
The Public site is intended to be a heavily cached public site with no behaviour that requires authentication, excluding the Wagtail Admin. The ultimate aim would be to serve this site statically.
The coupling between the Public and Apply sites has been done in such as way as to minimise the interaction between the two sites and facilitate a means of separation should the need arise. Their relationship is defined in the Public fund models:
The public site relies on the apply site to provide information on the related round status, open or closed and any closing dates for the round. The majority of this is within the apply cta.
Removing the database relationship and exposing the required data over an API would be all thats required to split the two sites.
The application_public and lab_public relations are then exposed on the application models through the detail attribute which is used to provide a link back to the public page in a few locations. References to these attributes should be kept to a minimum and could be replaced with a URL field to achieve seperation of Public and Apply portions of the project.
The two site have different url configurations, this limits the Apply site to a subset of the urls in the project. This is configured as part of the middleware stack using apply_url_conf_middleware. This swaps out the url configuration based on the site homepage configured in the wagtail admin.
The default url configuration is for the Public site which are shared by the Public and Apply sites.
The Public site has access to the "public authentication" urls, this enables reverse lookup of the url in templates, such as the login button, but the user is redirected to the apply site. Visiting https://<publicsite>/login will present a login screen.