Commit Graph

114 Commits

Author SHA1 Message Date
Abhishek Menon 1c57786387 Add missing `post_schema_sync` signal documentation
I am adding the `post_schema_sync` signal documentation which was missing. Right now the sender is TenantMixin. Although I believe it's better to make the Tenant Model itself as the sender, if that is possible. Your thoughts?
2018-08-12 21:31:13 +02:00
Michael Anckaert 20c72782ce Improved documentation on working with and creating tenants (#514)
* Improved documentation on working with and creating tenants

* Updated documentation according to requested changes
2017-12-01 19:52:16 +11:00
Gary Reynolds 874db6aa25 Merge #462 2017-06-02 18:35:53 +10:00
Gary Reynolds f0d3df2290 Remove documentation referring to unsupported version. 2017-06-02 18:30:12 +10:00
Stéphane Raimbault 4131b5f3ff Don't run makemigrations until set up is done (#459) 2017-05-25 16:08:59 +02:00
Bernardo Pires 4a49516c4a Updated docs regarding tests 2017-05-06 07:21:48 -05:00
Bernardo Pires 400fdc26f3 Create install.rst
Remove outdated setting TENANT_CREATION_FAKES_MIGRATIONS from the docs. Fixes #458.
2017-05-05 16:15:10 -05:00
Bernardo Pires 9dd3858dae Merge pull request #452 from Jorl17/master
Added BaseTenantMiddleware for easier custom middleware support. Thanks @Jorl17.
2017-04-23 23:00:35 +02:00
Mateu Cànaves 73fdfdff8e Resolved conflicts 2017-04-18 12:19:40 +02:00
Gary Reynolds 42ef023436 Updates for Django 1.11 2017-04-16 22:35:33 +10:00
Stéphane Raimbault 8faa5a74bb Fix documentation about custom management commands (#464) 2017-04-12 15:08:55 +10:00
Stéphane Raimbault cf154c6463 Upgrade installation documentation for Django 1.8+ 2017-03-21 14:59:42 +01:00
Mateu Cànaves 45157bf459 Update docs with new command info 2017-03-10 16:11:15 +01:00
João Ricardo Lourenço b0dc8bdb54 Add an advanced usage section to the documentation 2017-03-09 16:33:57 +00:00
Gary Reynolds 2e789f71bc TenantStorageMixin (#442)
* Add a tenant aware storage backend.

Using a mixin that can be combined with existing core and 3rd party
storage backends which isolates user uploaded media by introducing a
directory based on the schema_name (which shouldn't change after it's
been created) and a symbolic link from the domain_url to the directory.

In the reverse proxy, the domain_url can be parametrised to serve the
content via the symbolic link.

* WARN if project is not using a tenant aware storage backend.

* Add collectstatic_schemas management command

* Update the __all__ directive for tenant_schemas.storage

* Update test project for storage mixins

* Add documentation for DEFAULT_FILE_STORAGE changes
2017-02-22 20:08:37 +11:00
Stéphane Raimbault 80b148eb1b 'tenant_schemas' must be put at the top of INSTALLED_APPS 2017-02-09 21:59:58 +01:00
Stéphane Raimbault aef4292b9f Cleanup trailing spaces in documentation 2017-02-09 21:59:31 +01:00
Gary Reynolds 32b85e3bad Merge pull request #421 from AlexvEck/default-tenant-fix
Closes #383.

Thank you to @UnrealAkama for the original contribution and @AlexvEck for adding the initial tests.
2017-01-27 07:02:26 +11:00
Gary Reynolds c77c13199b Fix typo in documentation 2017-01-26 09:16:10 +11:00
Alexander van Eck 4c207fc676 #430 - Added an index check for ‘tenant_schemas’ in INSTALLED_APPS that checks whether it is placed before any django app instead if it is placed first. 2017-01-25 16:47:35 +01:00
Gary Reynolds b24faa0a73 Add middlewares to documentation (commented) 2017-01-26 01:44:55 +11:00
Gary Reynolds 5f169a276c Alternative implementation without introducing new settings.
Create a new subclass of TenantMiddleware which handles the fallback scenario.
2017-01-26 00:53:36 +11:00
Alexander van Eck 36d4966a03 Renamed DEFAULT_SCHEMA to DEFAULT_SCHEMA_NAME and added with.settings instead of overwriting settings in a test. 2017-01-25 14:32:51 +01:00
Alexander van Eck 021e667231 Added Default_Schema settings to the install.rst documentation 2017-01-01 11:38:19 +01:00
Gary Reynolds 2190883129 Document a position on supported versions of Django & PostgreSQL
- policy for Django (all currently supported versions)
- policy for PostgreSQL (minimum version of latest Django version)

Upped the link to PostgreSQL's schema documentation to match new minimum (9.2).
2016-11-11 17:26:23 +11:00
Gary Reynolds ea95f3f7a4 Refactor ImproperlyConfigured to system check framework
- ensure TENANT_APPS is defined in settings.py
- ensure TENANT_MODEL is defined in settings.py
- ensure TenantSyncRouter appears in DATABASE_ROUTERS
- ensure public schema and any existing tenant schemas are not listed in PG_EXTRA_SEARCH_PATHS
- raise error when TENANT_APPS is empty
- issue warning when 'tenant_schemas' is not the last item in INSTALLED_APPS
- issue warning when items in TENANT_APPS are not in INSTALLED_APPS
- add checks for SHARED_APPS
- add test cases for the best_practice system check
- update install documentation which previously suggested concatenation
- fix import path of get_public_schema_name
- fix failing test case for TenantContextFilter
- update tox.ini
- add .travis.yml
- PEP8 fixes
2016-11-11 07:57:14 +11:00
Farooq Azam 529361a85f Removed quotes from username value for createsuperuser command 2016-10-21 16:26:02 +05:00
Bernardo Pires ba73de494a Merge pull request #390 from filipeximenes/fast-testcase
Added FastTenantTestCase and its documentation
2016-10-04 23:03:47 +02:00
Filipe Ximenes 016e2682dd improving documentation texto for FastTenantTestCase 2016-10-04 17:34:46 -03:00
Bernardo Pires 906160f357 Update use.rst 2016-10-03 22:44:36 +02:00
Bernardo Pires 805d58a8fb Updated utils docs 2016-10-03 22:44:00 +02:00
Bernardo Pires a4ad7980b9 Revert "Documenting 'utils' module" 2016-10-03 22:38:46 +02:00
Filipe Ximenes fb2ec81d0f documenting 'utils' module 2016-10-03 11:22:06 -03:00
Filipe Ximenes a3b23d5f3a adding example on how to import FastTenantTestCase 2016-10-03 10:27:15 -03:00
Filipe Ximenes e9d90b6cd7 adding FastTenantTestCase and it's documentation 2016-10-03 10:24:09 -03:00
Bernardo Pires 0a9583e954 Now listing the correct context processor in the docs. Fixes #367. 2016-10-01 18:44:31 +02:00
Bernardo Pires cc437ed830 Remove line that says that contenttypes must be in TENANT_APPS. Fixes #369. 2016-10-01 18:42:24 +02:00
Justin Wunderle d9ce4ff99a Add TenantContextFilter - put schema_name and domain_url in log records
Add a LOGGING configuration similar to the section below.

    LOGGING = {
        'filters': {
            'tenant_context': {
                '()': 'tenant_schemas.log.TenantContextFilter',
            },
        },
        'formatters': {
            'default': {
                'format': '[%(schema_name)s:%(domain_url)s] '
                          '%(levelname)s %(asctime)s '
                          '%(message)s',
            },
        },
        'handlers': {
            'console': {
                'class': 'logging.StreamHandler',
                'formatter': 'default',
                'filters': ['tenant_context'],
            },
        },
    }

Your logging output will not look something like:

    [example:example.com] DEBUG 13:29 django.db.backends: (0.001) SELECT ...
2016-09-26 07:40:35 +10:00
Bernardo Pires 5d33237ba0 Merge pull request #321 from mikicz/ignore-missing-schemas
Raising an exception when a schema is missing, added an option to migrate_schemas to ignore this error
2016-09-21 21:07:00 +02:00
Mikuláš Poul d1e8484252 Wrote some docs for utils 2016-06-22 16:15:51 +02:00
Mikuláš Poul c4129e540b Merge branch 'master' into ignore-missing-schemas
Conflicts:
	docs/use.rst
	tenant_schemas/management/commands/migrate_schemas.py
2016-06-22 15:47:45 +02:00
Bernardo Pires 7b4182aeca Removing mentions to south 2016-05-30 00:12:17 +02:00
Bernardo Pires f1e322ae6c Merge branch 'master' of github.com:bernardopires/django-tenant-schemas 2016-05-30 00:08:28 +02:00
Bernardo Pires 63ae15f1b8 Changed readthedocs.org to readthedocs.io 2016-05-30 00:08:23 +02:00
Gary Reynolds cb8862d026 Remove Django < 1.8 compatibility
- resolves template loading in Django 1.8+ (thanks to @tomturner)
 - removed code branches based on django.VERSION value
 - updated documentation to remove details of removed functionality

Closes #289
2016-05-18 22:18:31 +10:00
Mikuláš Poul bb536708c4 Removed the --ignore-missing-schemas option, raising a different exception 2016-04-07 17:23:41 +02:00
Mikuláš Poul 538fdf48f1 Raising an exception when a schema is missing, added an option to migrate_schemas to ignore this error 2016-02-20 21:17:39 +01:00
Gary Reynolds d54c947f70 Documentation update. 2016-01-21 07:28:44 +11:00
Bernardo Pires 6f2afa0751 Updated documentation to remind users to create migrations for the tenant model 2015-12-28 17:17:49 +01:00
Shabda Raaj 1e075ef7cc optimize docs for readability 2015-10-03 19:13:52 +05:30