Mercurial > p > roundup > code
annotate detectors/README.txt @ 7340:7b9bddda9d2d
Add support for demo mode in docker.
roundup/demo.py
Make changes to allow exposed port in docker to be specified
separately from the port that demo mode binds to. Also permit
bind address specification as well.
roundup/scripts/roundup_demo.py:
Update required by changes in demo.py. Also move away from
positional arguments to prefer flag arguments. Required for
passing port and host specification. Flake8 fixes.
share/man/man1/roundup-demo.1
Document use of option flags rather than positional
params. Other cleanups.
doc/installation.txt:
Document new docker modes: demo, shell and admin.
Update docs:
overview section - reorg, added template info
for the impatient section - added docker demo mode reference,
more docs on top level demo.py use.
new section on docker demo mode
removed getting roundup section. folded into installing roundup.
also prior for the impatient section describes how to download.
install via pip in venv recommended supported method
document all provided templates. not just minimal and classic.
added index references.
move sections around, decreased sectin depth, reformatting
scripts/Docker/roundup_healthcheck:
When running roundup-demo, there is no tracker spec. So default to
demo if no tracker=directory args found. Prevent's docker from
reporting an unhealthy container when running demo.
scripts/Docker/roundup_start:
implement demo, shell, admin docker modes.
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Sun, 14 May 2023 09:43:53 -0400 |
| parents | b2eb59ada444 |
| children | e738377b4ffe |
| rev | line source |
|---|---|
|
5115
ec06bd6ea156
issue2550767: Add newitemcopy.py detector to notify users of new
John Rouillard <rouilj@ieee.org>
parents:
diff
changeset
|
1 This directory has some detector examples that you can use to get |
|
ec06bd6ea156
issue2550767: Add newitemcopy.py detector to notify users of new
John Rouillard <rouilj@ieee.org>
parents:
diff
changeset
|
2 ideas on implementing your own detectors. |
|
ec06bd6ea156
issue2550767: Add newitemcopy.py detector to notify users of new
John Rouillard <rouilj@ieee.org>
parents:
diff
changeset
|
3 |
|
ec06bd6ea156
issue2550767: Add newitemcopy.py detector to notify users of new
John Rouillard <rouilj@ieee.org>
parents:
diff
changeset
|
4 These are provides on an as-is basis. When they were added, they |
|
ec06bd6ea156
issue2550767: Add newitemcopy.py detector to notify users of new
John Rouillard <rouilj@ieee.org>
parents:
diff
changeset
|
5 worked for somebody and were considered a useful example. |
|
ec06bd6ea156
issue2550767: Add newitemcopy.py detector to notify users of new
John Rouillard <rouilj@ieee.org>
parents:
diff
changeset
|
6 |
|
ec06bd6ea156
issue2550767: Add newitemcopy.py detector to notify users of new
John Rouillard <rouilj@ieee.org>
parents:
diff
changeset
|
7 The roundup team will attempt to keep them up to date with major |
|
ec06bd6ea156
issue2550767: Add newitemcopy.py detector to notify users of new
John Rouillard <rouilj@ieee.org>
parents:
diff
changeset
|
8 changes as they happen, but there are no guarantees that these will |
|
ec06bd6ea156
issue2550767: Add newitemcopy.py detector to notify users of new
John Rouillard <rouilj@ieee.org>
parents:
diff
changeset
|
9 work out of the box. If you find them out of date and have patches to |
|
ec06bd6ea156
issue2550767: Add newitemcopy.py detector to notify users of new
John Rouillard <rouilj@ieee.org>
parents:
diff
changeset
|
10 make them work against newer versions of roundup, please open an issue |
|
ec06bd6ea156
issue2550767: Add newitemcopy.py detector to notify users of new
John Rouillard <rouilj@ieee.org>
parents:
diff
changeset
|
11 at: |
|
ec06bd6ea156
issue2550767: Add newitemcopy.py detector to notify users of new
John Rouillard <rouilj@ieee.org>
parents:
diff
changeset
|
12 |
|
6265
b2eb59ada444
Replace http:....roundup-tracker.org with https. Also fix wiki links.
John Rouillard <rouilj@ieee.org>
parents:
5115
diff
changeset
|
13 https://issues.roundup-tracker.org |
|
5115
ec06bd6ea156
issue2550767: Add newitemcopy.py detector to notify users of new
John Rouillard <rouilj@ieee.org>
parents:
diff
changeset
|
14 |
|
ec06bd6ea156
issue2550767: Add newitemcopy.py detector to notify users of new
John Rouillard <rouilj@ieee.org>
parents:
diff
changeset
|
15 The current inventory is: |
|
ec06bd6ea156
issue2550767: Add newitemcopy.py detector to notify users of new
John Rouillard <rouilj@ieee.org>
parents:
diff
changeset
|
16 |
|
ec06bd6ea156
issue2550767: Add newitemcopy.py detector to notify users of new
John Rouillard <rouilj@ieee.org>
parents:
diff
changeset
|
17 creator_resolution.py - only allow the creator of the issue to resolve it |
|
ec06bd6ea156
issue2550767: Add newitemcopy.py detector to notify users of new
John Rouillard <rouilj@ieee.org>
parents:
diff
changeset
|
18 |
|
ec06bd6ea156
issue2550767: Add newitemcopy.py detector to notify users of new
John Rouillard <rouilj@ieee.org>
parents:
diff
changeset
|
19 emailauditor.py - Rename .eml files (from email multi-part bodies) to |
|
ec06bd6ea156
issue2550767: Add newitemcopy.py detector to notify users of new
John Rouillard <rouilj@ieee.org>
parents:
diff
changeset
|
20 .mht so they can be downloaded/viewed in Internet Explorer. |
|
ec06bd6ea156
issue2550767: Add newitemcopy.py detector to notify users of new
John Rouillard <rouilj@ieee.org>
parents:
diff
changeset
|
21 |
|
ec06bd6ea156
issue2550767: Add newitemcopy.py detector to notify users of new
John Rouillard <rouilj@ieee.org>
parents:
diff
changeset
|
22 irker.py - communicate with irkerd to allow roundtup to send announcements |
|
ec06bd6ea156
issue2550767: Add newitemcopy.py detector to notify users of new
John Rouillard <rouilj@ieee.org>
parents:
diff
changeset
|
23 to an IRC channel. |
|
ec06bd6ea156
issue2550767: Add newitemcopy.py detector to notify users of new
John Rouillard <rouilj@ieee.org>
parents:
diff
changeset
|
24 |
|
ec06bd6ea156
issue2550767: Add newitemcopy.py detector to notify users of new
John Rouillard <rouilj@ieee.org>
parents:
diff
changeset
|
25 newissuecopy.py - notify a team email address (hardcoded in the script) |
|
ec06bd6ea156
issue2550767: Add newitemcopy.py detector to notify users of new
John Rouillard <rouilj@ieee.org>
parents:
diff
changeset
|
26 when a new issue arrives. |
|
ec06bd6ea156
issue2550767: Add newitemcopy.py detector to notify users of new
John Rouillard <rouilj@ieee.org>
parents:
diff
changeset
|
27 |
|
ec06bd6ea156
issue2550767: Add newitemcopy.py detector to notify users of new
John Rouillard <rouilj@ieee.org>
parents:
diff
changeset
|
28 newitemcopy.py - email the DISPATCHER address when new issues, users, |
|
ec06bd6ea156
issue2550767: Add newitemcopy.py detector to notify users of new
John Rouillard <rouilj@ieee.org>
parents:
diff
changeset
|
29 keywords etc. are created. Kind of an expanded version |
|
ec06bd6ea156
issue2550767: Add newitemcopy.py detector to notify users of new
John Rouillard <rouilj@ieee.org>
parents:
diff
changeset
|
30 of newissuecopy. |
