Commit Graph

64 Commits

Author SHA1 Message Date
Simon Michael
60f7896dd5 fix:web: drop non-working --file-url option for now [#2139] 2023-12-15 13:58:25 -10:00
Simon Michael
569d2c8e5f doc:web: clean up options and manual [#2134] 2023-12-14 15:31:49 -10:00
Simon Michael
0c85b48d2c ;doc: use ``cli not ``shell for command-line examples 2023-11-26 08:30:04 -10:00
Simon Michael
795dbd97f8 imp:web: cleanups; use --allow on Sandstorm (#834) 2023-10-24 13:37:36 +01:00
Simon Michael
95d33f20f6 imp:web: access control UX cleanups (fix #834)
Changes:

1. rename the sandstorm "manage" permission to "edit"
(old permission names: view, add, manage;
 new permission names: view, add, edit).

Rationale: "edit" best describes this permission's current powers, to users and to operators.
If we ever added more manager-type features we'd want that to be a new permission,
not a rename of the existing one (which would change the powers of existing users).

2. rename the sandstorm roles for consistency with permissions
(old role names: viewer, editor, manager;
 new role names: viewer, adder, editor)

Rationale: it's needed to avoid confusion.

3. add a new option: --allow=view|add|edit|sandstorm (default: add).
'sandstorm' sets permissions according to the X-Sandstorm-Permissions header.
Drop the --capabilities and --capabilities-header options.

Rationale: it's simpler and more intuitive.

4. replace "capability" with "permission" in ui/docs/code.

Rationale: consistent with the above, more familiar.
2023-10-24 13:37:36 +01:00
Simon Michael
858135e15e ;doc: simplify man page synopses to suit website 2023-05-31 19:07:02 -10:00
Simon Michael
3ddb43663c ;cln:doc: man page cleanups 2023-05-31 16:42:11 -10:00
Simon Michael
b0e5bb4bc7 ;imp:doc: ui, web: options cleanup 2023-05-30 22:35:01 -10:00
Simon Michael
34a6c08b03 ;imp:doc:cli: move Input section first, consolidate LEDGER_FILE docs 2023-05-26 09:01:34 -10:00
Simon Michael
c8c5f96ed0 ;cln:doc: ui, web manuals: drop redundant FILES section 2023-05-26 09:01:32 -10:00
Simon Michael
fda15f808c ;imp:doc:manuals: consolidate, update BUGS sections 2023-05-26 06:38:27 -10:00
Simon Michael
a717cbd300 ;cln:doc: update the manuals' brief input files descriptions
These come from the inputfiles (and new inputfileswithptr) macros,
currently used in five places in the three manuals.
2023-05-26 06:38:27 -10:00
Simon Michael
8a139ac939 ;doc: web: improve --base-url description (#1562) 2023-01-24 14:06:51 -10:00
Simon Michael
1ac5c0b03e ;doc: web: fix typo in macro 2022-12-14 21:26:23 -10:00
Simon Michael
43023d3d86 ;doc: some changes to hledger and input files description macros 2022-12-14 12:23:10 -10:00
Simon Michael
600e263a9a ;doc: cli, ui, web: consistent boilerplate 2022-12-11 15:44:09 -10:00
Simon Michael
abab1a23e3 ;doc: cli, ui, web: fix some links 2022-12-11 15:22:46 -10:00
Simon Michael
a7620f3102 ;doc: ui, web: show smaller screenshot thumbnails 2022-11-08 11:55:09 -10:00
Simon Michael
32d7cb5287 doc: ui, web: mention debug output 2022-11-03 17:16:55 -10:00
Simon Michael
d95786d2f2 doc: web: clarify the run modes 2022-11-03 08:10:45 -10:00
Simon Michael
f12ff0df3a ;doc: ui, web: move screenshot styles elsewhere 2021-07-28 22:24:25 -10:00
Simon Michael
eae4922d12 doc: info directory entries: fixes, cleanup (#1585) 2021-06-27 17:26:00 -10:00
Damien Cassou
f5633199dc ;doc: add DIR section to hledged.m4.md for the info file (#806)
This is used by `install-info` to generate an entry in the info
directory.
2021-06-27 15:11:29 -10:00
Simon Michael
d87751ef2e ;doc: ui, web: make image paths absolute 2021-03-21 09:10:50 -07:00
Simon Michael
d5a227f18c ;doc: ui, web, contributing: fix image urls 2021-03-21 07:45:37 -07:00
Simon Michael
f54f2b3b72 ;doc: also update manual source files (#1504) 2021-03-13 07:28:14 -08:00
Simon Michael
fbe30a73b9 ;doc: mention version in all manual formats 2020-12-24 17:25:11 -08:00
Simon Michael
fbf9418756 ;doc: update links to journal manual 2020-12-24 12:49:04 -08:00
Simon Michael
0ff65456fa ;doc: info: tweak first/top heading again to improve structure 2020-12-20 20:08:35 -08:00
Simon Michael
9daaabeda2 ;doc: simplify manuals' title metadata to fit man/info better 2020-12-20 20:08:35 -08:00
Simon Michael
c92c27d565 doc: tweak manuals' top heading to improve info structure 2020-12-20 20:08:35 -08:00
Simon Michael
ee73a6aabf web: --test [-- HSPECARGS] runs the test suite 2020-11-16 14:02:16 -08:00
Simon Michael
fd200a85af web: /version provides hledger version string as JSON (#1152) 2020-09-29 17:28:03 -07:00
Martin Michlmayr
7310951178 doc: fix typos 2020-06-16 19:13:18 -07:00
Simon Michael
a91cb9036d ;web: update json api examples 2020-06-06 12:54:58 -07:00
Simon Michael
4294fd36a9 ;web: JSON docs 2020-05-21 12:51:29 -07:00
Simon Michael
20c480a914 ;web: tweak JSON PUT doc 2020-05-21 10:48:04 -07:00
Simon Michael
e207b089c5 ;web: tweak JSON PUT doc 2020-05-21 10:36:43 -07:00
Simon Michael
936233f5f6 ;web: tweak JSON PUT doc 2020-05-21 10:31:30 -07:00
Simon Michael
683641d0f2 ;web: tweak JSON PUT doc 2020-05-21 10:08:52 -07:00
Simon Michael
39ab2a6b2b ;web: tweak JSON PUT doc 2020-05-21 10:05:57 -07:00
Simon Michael
0cf5e010de ;web: tweak JSON PUT doc 2020-05-21 10:05:04 -07:00
Simon Michael
fab62b4cc3 ;web: tweak JSON PUT doc 2020-05-21 09:59:14 -07:00
Simon Michael
7ccbfa11ac ;web: tweak JSON PUT doc 2020-05-21 09:57:27 -07:00
Simon Michael
0f922b3850 ;web: update JSON PUT example 2020-05-21 09:50:50 -07:00
Simon Michael
4c321cee4a ;doc: update output dest/format docs; add notes about JSON
[ci skip]
2020-02-25 09:25:48 -08:00
Simon Michael
4d94a5273b ;doc: manuals: whitespace cleanup
Remove a bunch of trailing whitespace with M-x whitespace-cleanup.
Except for examples showing hledger output, which might be tested
with shelltest some day, so stripping that whitespace might be problematic.

[ci skip]
2020-02-08 12:44:54 -08:00
Simon Michael
b1de2f2308 ;doc: drop redundant version message from web manuals
[ci skip]
2020-01-25 19:33:12 -08:00
Simon Michael
444c4342ed ;doc: manuals: hide NAME/SYNOPSIS/DESCRIPTION headings in web manuals
[ci skip]
2020-01-25 16:57:51 -08:00
Carl Richard Theodor Schneider
72acd7c22a web: Add option --socket to use UNIX socket file
This commit adds the --socket option to use hledger-web over an AF_UNIX socket
file.
It allows running multiple instances of hledger-web on the same system without
having to manually choose a port for each instance, which is helpful for running
individual instances for multiple users. In this scenario, the socket path is
predictable, as it can be derived from the username.

It also introduces the following dependencies:

 - network
   - Used to create the unix domain socket
 - unix-compat
   - Used to identify if the socket file is still a socket, to reduce the risk
     of deleting a file when cleaning up the socket
2020-01-12 16:15:37 -08:00