Mercurial > p > roundup > code
annotate 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 | 49761be4a931 |
| children | 1f6c77ee4b18 |
| rev | line source |
|---|---|
|
1576
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1409
diff
changeset
|
1 ======================================================= |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1409
diff
changeset
|
2 Roundup: an Issue-Tracking System for Knowledge Workers |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1409
diff
changeset
|
3 ======================================================= |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1409
diff
changeset
|
4 |
| 1639 | 5 INSTANT GRATIFICATION |
| 6 ===================== | |
| 7 | |
|
4812
bbfc87ecfdf1
Update README.txt, explain Tracker Home, improve doc
anatoly techtonik <techtonik@gmail.com>
parents:
4702
diff
changeset
|
8 The impatient may try Roundup immediately by running demo.py from |
|
bbfc87ecfdf1
Update README.txt, explain Tracker Home, improve doc
anatoly techtonik <techtonik@gmail.com>
parents:
4702
diff
changeset
|
9 the source directory:: |
| 1639 | 10 |
|
1640
d0b29215aa44
pre-release stuff
Richard Jones <richard@users.sourceforge.net>
parents:
1639
diff
changeset
|
11 python demo.py |
| 1639 | 12 |
|
4812
bbfc87ecfdf1
Update README.txt, explain Tracker Home, improve doc
anatoly techtonik <techtonik@gmail.com>
parents:
4702
diff
changeset
|
13 This will create new tracker home in "demo" subdirectory and start |
|
bbfc87ecfdf1
Update README.txt, explain Tracker Home, improve doc
anatoly techtonik <techtonik@gmail.com>
parents:
4702
diff
changeset
|
14 server. To reset demo instance:: |
|
1640
d0b29215aa44
pre-release stuff
Richard Jones <richard@users.sourceforge.net>
parents:
1639
diff
changeset
|
15 |
|
d0b29215aa44
pre-release stuff
Richard Jones <richard@users.sourceforge.net>
parents:
1639
diff
changeset
|
16 python demo.py nuke |
| 1639 | 17 |
|
4812
bbfc87ecfdf1
Update README.txt, explain Tracker Home, improve doc
anatoly techtonik <techtonik@gmail.com>
parents:
4702
diff
changeset
|
18 |
|
bbfc87ecfdf1
Update README.txt, explain Tracker Home, improve doc
anatoly techtonik <techtonik@gmail.com>
parents:
4702
diff
changeset
|
19 Tracker Home |
|
bbfc87ecfdf1
Update README.txt, explain Tracker Home, improve doc
anatoly techtonik <techtonik@gmail.com>
parents:
4702
diff
changeset
|
20 ============= |
|
bbfc87ecfdf1
Update README.txt, explain Tracker Home, improve doc
anatoly techtonik <techtonik@gmail.com>
parents:
4702
diff
changeset
|
21 "Tracker Home" is main concept when starting with Roundup. It is |
|
bbfc87ecfdf1
Update README.txt, explain Tracker Home, improve doc
anatoly techtonik <techtonik@gmail.com>
parents:
4702
diff
changeset
|
22 directory where all your tracker data is stored. This directory is |
|
bbfc87ecfdf1
Update README.txt, explain Tracker Home, improve doc
anatoly techtonik <techtonik@gmail.com>
parents:
4702
diff
changeset
|
23 created every time when new tracker is initialized and includes |
|
bbfc87ecfdf1
Update README.txt, explain Tracker Home, improve doc
anatoly techtonik <techtonik@gmail.com>
parents:
4702
diff
changeset
|
24 tracker configuration, database, template, schema and extensions. |
|
3646
3a9a6b98c6e6
note about where to run demo.py from
Richard Jones <richard@users.sourceforge.net>
parents:
1640
diff
changeset
|
25 |
|
3a9a6b98c6e6
note about where to run demo.py from
Richard Jones <richard@users.sourceforge.net>
parents:
1640
diff
changeset
|
26 |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
646
diff
changeset
|
27 Installation |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
646
diff
changeset
|
28 ============ |
|
4812
bbfc87ecfdf1
Update README.txt, explain Tracker Home, improve doc
anatoly techtonik <techtonik@gmail.com>
parents:
4702
diff
changeset
|
29 Please see "doc/installation.txt" |
|
94
9cf5229397fc
name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
30 |
|
1576
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1409
diff
changeset
|
31 |
|
796
5324a28060ab
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
791
diff
changeset
|
32 Upgrading |
|
5324a28060ab
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
791
diff
changeset
|
33 ========= |
|
4812
bbfc87ecfdf1
Update README.txt, explain Tracker Home, improve doc
anatoly techtonik <techtonik@gmail.com>
parents:
4702
diff
changeset
|
34 Please see "doc/upgrading.txt" |
|
4092
4b0ddce43d08
migrate from MimeWriter to email
Richard Jones <richard@users.sourceforge.net>
parents:
3949
diff
changeset
|
35 |
|
1576
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1409
diff
changeset
|
36 |
|
7127
49761be4a931
ADd reference to security.txt document.
John Rouillard <rouilj@ieee.org>
parents:
4812
diff
changeset
|
37 Security Issues |
|
49761be4a931
ADd reference to security.txt document.
John Rouillard <rouilj@ieee.org>
parents:
4812
diff
changeset
|
38 =============== |
|
49761be4a931
ADd reference to security.txt document.
John Rouillard <rouilj@ieee.org>
parents:
4812
diff
changeset
|
39 Please see "doc/security.txt" for directions on reporting security issues. |
|
49761be4a931
ADd reference to security.txt document.
John Rouillard <rouilj@ieee.org>
parents:
4812
diff
changeset
|
40 |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
646
diff
changeset
|
41 Usage and Other Information |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
646
diff
changeset
|
42 =========================== |
|
4812
bbfc87ecfdf1
Update README.txt, explain Tracker Home, improve doc
anatoly techtonik <techtonik@gmail.com>
parents:
4702
diff
changeset
|
43 Start with the index.txt file in the "doc" directory. These |
|
bbfc87ecfdf1
Update README.txt, explain Tracker Home, improve doc
anatoly techtonik <techtonik@gmail.com>
parents:
4702
diff
changeset
|
44 documentation files are written in reStructedText, which can be |
|
bbfc87ecfdf1
Update README.txt, explain Tracker Home, improve doc
anatoly techtonik <techtonik@gmail.com>
parents:
4702
diff
changeset
|
45 converted into HTML format. If you have Sphinx installed, you can |
|
bbfc87ecfdf1
Update README.txt, explain Tracker Home, improve doc
anatoly techtonik <techtonik@gmail.com>
parents:
4702
diff
changeset
|
46 do this by running:: |
|
bbfc87ecfdf1
Update README.txt, explain Tracker Home, improve doc
anatoly techtonik <techtonik@gmail.com>
parents:
4702
diff
changeset
|
47 |
|
bbfc87ecfdf1
Update README.txt, explain Tracker Home, improve doc
anatoly techtonik <techtonik@gmail.com>
parents:
4702
diff
changeset
|
48 python setup.py build_doc |
|
bbfc87ecfdf1
Update README.txt, explain Tracker Home, improve doc
anatoly techtonik <techtonik@gmail.com>
parents:
4702
diff
changeset
|
49 |
|
bbfc87ecfdf1
Update README.txt, explain Tracker Home, improve doc
anatoly techtonik <techtonik@gmail.com>
parents:
4702
diff
changeset
|
50 Resulting HTML files will be in "share/doc/roundup/html" directory. |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
646
diff
changeset
|
51 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
646
diff
changeset
|
52 |
|
4563
ef3e3c5e3501
Point new developers at the developers,txt file.
Eric S. Raymond <esr@thyrsus.com>
parents:
4092
diff
changeset
|
53 For Developers |
|
ef3e3c5e3501
Point new developers at the developers,txt file.
Eric S. Raymond <esr@thyrsus.com>
parents:
4092
diff
changeset
|
54 ============== |
|
ef3e3c5e3501
Point new developers at the developers,txt file.
Eric S. Raymond <esr@thyrsus.com>
parents:
4092
diff
changeset
|
55 To get started on development work, read the developers.txt file in |
|
ef3e3c5e3501
Point new developers at the developers,txt file.
Eric S. Raymond <esr@thyrsus.com>
parents:
4092
diff
changeset
|
56 the "doc" directory. |
|
ef3e3c5e3501
Point new developers at the developers,txt file.
Eric S. Raymond <esr@thyrsus.com>
parents:
4092
diff
changeset
|
57 |
|
ef3e3c5e3501
Point new developers at the developers,txt file.
Eric S. Raymond <esr@thyrsus.com>
parents:
4092
diff
changeset
|
58 |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
646
diff
changeset
|
59 License |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
646
diff
changeset
|
60 ======= |
|
1409
8dc60d87ab42
Fixed a backlog of bug reports, and worked on python 2.3 compatibility:
Richard Jones <richard@users.sourceforge.net>
parents:
1071
diff
changeset
|
61 See COPYING.txt |
