summaryrefslogtreecommitdiff
path: root/docs/deployment
Commit message (Collapse)AuthorAge
* docs: Refresh the guide for Ubuntu 20.04Stephen Finucane2021-02-20
| | | | | | | Nothing changes wrt package names, which is nice. We take the opportunity to clarify some wording, however. Signed-off-by: Stephen Finucane <stephen@that.guru>
* docs: Update docs to point to v3.0.0 releaseStephen Finucane2021-02-20
| | | | Signed-off-by: Stephen Finucane <stephen@that.guru>
* docs: Note UTF-8 requirements for databasesStephen Finucane2021-02-20
| | | | | | | | MySQL 5.3 defaulted to 'latin1' encoding, meaning users would need to explicitly configure their databases to use 'utf8'. Call this out. Signed-off-by: Stephen Finucane <stephen@that.guru> Closes: #393
* management: introduce replacerelations commandRohit Sarkar2020-08-10
| | | | | | | | | | | | | The replacerelations script is used to ingest relations into Patchwork's patch database. A patch groups file is taken as input, which on each line contains a space separated list of patchwork ids denoting a relation. All the existing relations in Patchwork's database are removed and the relations read from the patch groups file are ingested. Signed-off-by: Rohit Sarkar <rohitsarkar5398@gmail.com> [dja: pep8, drop relations directory as empty dirs don't get stored by git, comment about how lines are generated.] Signed-off-by: Daniel Axtens <dja@axtens.net>
* Additional Python 2.7 cleanupsStephen Finucane2020-04-09
| | | | Signed-off-by: Stephen Finucane <stephen@that.guru>
* docs: Remove references to Python 2.7Stephen Finucane2020-04-08
| | | | Signed-off-by: Stephen Finucane <stephen@that.guru>
* Replace references to Django 1.11 docsStephen Finucane2020-04-08
| | | | | | | This is a straight forward swap, thankfully. Django 2.2 is chosen as it's the latest LTS. Signed-off-by: Stephen Finucane <stephen@that.guru>
* docs: Reference Patchwork 2.2 tarballsStephen Finucane2020-04-08
| | | | | | This is what users will want right now. Signed-off-by: Stephen Finucane <stephen@that.guru>
* docs: Fix note about the required Postfix rightsAli Alnubani2019-11-30
| | | | | | | | | | | | | | The permissions for the user running the postfix process are not the ones used for external file or command delivery by default. The ones defined by default_privs are (in case the aliases(5) file that is owned by root was being used). A privileged user or the postfix owner should not be used in this case. See http://www.postfix.org/postconf.5.html#default_privs and local(8). Signed-off-by: Ali Alnubani <alialnu@mellanox.com> Reviewed-by: Stephen Finucane <stephen@that.guru>
* Use secrets and fall back to random.SystemRandom for keysJeremy Cline2019-10-17
| | | | | | | | | | | | | | | | | | The random module uses the Mersenne Twister pseudorandom number generator and is not a cryptographically secure random number generator[0]. The secrets[1] module is intended for generating cryptographically strong random numbers, so recommend using that to generate the secret key. It's new in Python 3, so if it's unavailable fall back to using the ``os.urandom()`` backed implementation of random. NOTE(stephenfin): Modified to include change to 'config.yaml'. Also renamed reno to just stick with hyphens for filenames. [0] https://docs.python.org/3/library/random.html [1] https://docs.python.org/3/library/secrets.html Signed-off-by: Jeremy Cline <jcline@redhat.com> Signed-off-by: Stephen Finucane <stephen@that.guru>
* Add 'dumparchive' management commandMete Polat2019-07-19
| | | | | | | | | Introduces a new management command which can export all patches in a project as one mbox file. Export of multiple projects is supported. Additionally allows to compress the output. Signed-off-by: Mete Polat <metepolat2000@gmail.com> Signed-off-by: Stephen Finucane <stephen@that.guru>
* docs: Rework configuration documentStephen Finucane2019-07-06
| | | | | | | | | - Remove some newlines between terms and definitions that were causing the latter to be rendered as blockquotes instead - Order list of settings alphabetically - Update URLs to use latest version of Django we support Signed-off-by: Stephen Finucane <stephen@that.guru>
* about: Display admin contact detailsAndrew Donnellan2019-07-05
| | | | | | | | | Display the list of admins on the about page. Add an ADMINS_HIDE option if you don't want the details displayed publicly. Closes: #282 ("Display contact details for patchwork instance admins") Signed-off-by: Andrew Donnellan <ajd@linux.ibm.com> Signed-off-by: Stephen Finucane <stephen@that.guru>
* Remove pwclientStephen Finucane2019-06-17
| | | | | | | | | Let's start managing this via a separate project, which will allow the client to evolve separately from the server. No redirect is added for the old '/pwclient' URL as it seems wiser to return a HTTP 404 error code. Signed-off-by: Stephen Finucane <stephen@that.guru>
* docs: Move REST API guide to subfolderStephen Finucane2019-01-29
| | | | | | | | | | We're going to dramatically expand these docs, so let's set up room to do so. This shouldn't break any links as we're using 'htmldir' output on ReadTheDocs. Signed-off-by: Stephen Finucane <stephen@that.guru>
* docs: Fix documentation of REST_RESULTS_PER_PAGE settingAndrew Donnellan2018-08-26
| | | | | | | | | | In 8fe11180a1a5 ("REST: Add new setting for maximum API page size") I accidentally deleted the versionadded information for REST_RESULTS_PER_PAGE. Restore it. Fixes: 8fe11180a1a5 ("REST: Add new setting for maximum API page size") Signed-off-by: Andrew Donnellan <andrew.donnellan@au1.ibm.com> Signed-off-by: Daniel Axtens <dja@axtens.net>
* REST: Add new setting for maximum API page sizeAndrew Donnellan2018-08-26
| | | | | | | | | | | | | | | | | | In 41790caf59ad ("REST: Limit max page size") we limited the maximum page size to the default page size in the settings. This turns out to be rather restrictive, as we usually want to keep the default page size low, but an administrator may want to allow API clients to fetch more than that per request. Add a new setting, MAX_REST_RESULTS_PER_PAGE, to set the maximum page size. Closes: #202 ("Separate max API page size and default API page size into different settings") Suggested-by: Stewart Smith <stewart@linux.ibm.com> Suggested-by: Joel Stanley <joel@jms.id.au> Signed-off-by: Andrew Donnellan <andrew.donnellan@au1.ibm.com> [dja: set to 250 as per mailing list discussion] Signed-off-by: Daniel Axtens <dja@axtens.net>
* docs: Update deployment installation guide for v2.1Stephen Finucane2018-06-02
| | | | | | | | | | | | There are no actual changes needed from the Patchwork side so this is mostly a cleanup. - Use Ubuntu 18.04 (including package names) - Resolve some minor issues with commands - Remove use of "trust" authentication for PostgreSQL - Minor style changes Signed-off-by: Stephen Finucane <stephen@that.guru>
* docs: Random fixesStephen Finucane2018-04-24
| | | | | | | Remove an unnecessary 'toctree' from the index page and fix some definition lists. Signed-off-by: Stephen Finucane <stephen@that.guru>
* Remove support for Django 1.6, 1.7Stephen Finucane2018-01-04
| | | | | | | | | | | | These versions are massively outdated and the only reason for keeping them was to allow installation on RHEL 7 using the version provided via EPEL. No one's actually using this so just kill it. This also allows us to remove support for django-filter 0.11, which was only retained for use with these older versions of Django. Signed-off-by: Stephen Finucane <stephen@that.guru> Reviewed-by: Daniel Axtens <dja@axtens.net>
* doc: Remove references to 'UPGRADING' and 'CHANGELOG'Stephen Finucane2018-01-04
| | | | | | | | These documents have been replaced by release notes. Remove references to them. Signed-off-by: Stephen Finucane <stephen@that.guru> Reviewed-by: Daniel Axtens <dja@axtens.net>
* docs: Add index pagesStephen Finucane2017-11-02
| | | | | | | | This lets me go to, for example, the following URLs: https://patchwork.readthedocs.io/en/latest/releases/ Signed-off-by: Stephen Finucane <stephen@that.guru>
* docs: Document the various management commands availableStephen Finucane2017-05-30
| | | | | | | | As requested. Signed-off-by: Stephen Finucane <stephen@that.guru> Reported-by: Thomas Monjalon <thomas@monjalon.net> Closes-bug: #77
* docs: Don't mention 'default_project' in deployment guideStephen Finucane2017-05-18
| | | | | | | | | | | | | The deployment guide currently suggests using the 'default_project' fixture when deploying a production installation of Patchwork. While one _could_ use this, it's generally unnecessary given that most people care about their own projects and not Patchwork. Resolve this by simply removing any references. The references are retained for the development installation guide, as they're likely useful here. Signed-off-by: Stephen Finucane <stephen@that.guru>
* docs: Update installation guide for Ubuntu 16.04Stephen Finucane2017-05-04
| | | | | | | | | | Use the latest LTS version of Ubuntu. This is mostly a simplification of the guide, which reverts back to single-node configuration and increases the emphasis on installing system packages rather than using 'pip'. There are also a series of corrections, mostly around using the Python 3 variants of packages. Signed-off-by: Stephen Finucane <stephen@that.guru>
* docs: Emphasise the cron jobStephen Finucane2017-04-29
| | | | | | | | | Having talked to a few folks deploying Patchwork, it appears not everyone is aware of/enabling the Patchwork cron job. Emphasise this feature by moving it to its own section. This section is marked as optional, given that it's not truly required but is helpful. Signed-off-by: Stephen Finucane <stephen@that.guru>
* docs: Add a configuration guideStephen Finucane2017-04-29
| | | | | | | | | | This should simplify matters for folks that don't have much experience with Django. It also serves to highlight the 'ENABLE_REST_API' option. A release note is also added to capture the rename of DEFAULT_PATCHES_PER_PAGE that has occurred during this cycle. Signed-off-by: Stephen Finucane <stephen@that.guru>
* docs: Remove old Markdown filesStephen Finucane2017-04-18
| | | | | | | Everything is now ported to rST/Sphinx meaning we can remove the Markdown versions. Signed-off-by: Stephen Finucane <stephen@that.guru>
* docs: Convert deployment guideStephen Finucane2017-04-18
| | | | Signed-off-by: Stephen Finucane <stephen@that.guru>
* docs: fix links to installation pagesDenis Laxalde2017-02-06
| | | | | | Signed-off-by: Denis Laxalde <denis@laxalde.org> Reviewed-by: Daniel Axtens <dja@axtens.net> Reviewed-by: Stephen Finucane <stephen@that.guru>
* docs: fix links to "contributing" pageDenis Laxalde2017-02-06
| | | | | | Signed-off-by: Denis Laxalde <denis@laxalde.org> Reviewed-by: Daniel Axtens <dja@axtens.net> Reviewed-by: Stephen Finucane <stephen@that.guru>
* docs: Add getmail documentationStephen Finucane2016-10-22
| | | | | | | | | | It seems a lot of people are having success using tools like fetchmail in combination with IMAP/POP-capable email accounts like Gmail. While fetchmail itself is rather decrepit, the Python-based getmail seems actively supported and pretty easy to configure. Document this process. Signed-off-by: Stephen Finucane <stephen@that.guru> Reviewed-by: Daniel Axtens <dja@axtens.net>
* docs: Structure docs folder like onlineStephen Finucane2016-10-11
The XML-RPC doc is renamed accordingly. Signed-off-by: Stephen Finucane <stephen@that.guru>
generated by cgit v1.2.3 (git 2.25.4) at 2024-06-23 08:04:24 +0000