diff --git a/CHANGES.md b/CHANGES.md --- a/CHANGES.md +++ b/CHANGES.md @@ -9,7 +9,14 @@ User-visible changes in hledger-web. See also the hledger changelog. -# 1.28 2022-11-30 +# 1.29 2023-03-11 + +- The add form's typeahead now shows non-ascii text correctly. + (#1961) (Arsen Arsenović) + +- In the manual, improve --base-url's description. (#1562) + +# 1.28 2022-12-01 Improvements diff --git a/Hledger/Web/Settings.hs b/Hledger/Web/Settings.hs --- a/Hledger/Web/Settings.hs +++ b/Hledger/Web/Settings.hs @@ -34,7 +34,7 @@ hledgerorgurl = "http://hledger.org" manualurl :: Text -manualurl = hledgerorgurl <> "/manual" +manualurl = hledgerorgurl <> "hledger.html" -- | The default IP address to listen on. May be overridden with --host. defhost :: String diff --git a/Hledger/Web/Test.hs b/Hledger/Web/Test.hs --- a/Hledger/Web/Test.hs +++ b/Hledger/Web/Test.hs @@ -97,5 +97,5 @@ yit "serves a journal page showing forecasted transactions" $ do get JournalR statusIs 200 - bodyContains "id=\"transaction-0-1\"" -- 0 indicates a fileless (forecasted) txn - bodyContains "id=\"transaction-0-2\"" -- etc. + bodyContains "id=\"transaction-2-1\"" + bodyContains "id=\"transaction-2-2\"" diff --git a/Hledger/Web/Widget/AddForm.hs b/Hledger/Web/Widget/AddForm.hs --- a/Hledger/Web/Widget/AddForm.hs +++ b/Hledger/Web/Widget/AddForm.hs @@ -28,6 +28,7 @@ import Hledger.Web.Foundation (App, Handler, Widget) import Hledger.Web.Settings (widgetFile) import Data.Function ((&)) +import Control.Arrow (right) addModal :: Route App -> Journal -> Day -> Widget addModal addR j today = do @@ -61,7 +62,7 @@ return (formRes, $(widgetFile "add-form")) where -- custom fields - dateField = textField & checkMMap (pure . validateDate) (T.pack . show) + dateField = textField & checkMMap (pure . right fromEFDay . validateDate) (T.pack . show) where validateDate s = first (const ("Invalid date format" :: Text)) $ @@ -190,7 +191,8 @@ "]" ] where - b64wrap = ("atob(\""<>) . (<>"\")") . encodeBase64 + -- decodeBase64EncodedText is defined in add-form.hamlet + b64wrap = ("decodeBase64EncodedText(\""<>) . (<>"\")") . encodeBase64 zipDefault :: a -> [a] -> [a] -> [(a, a)] zipDefault def (b:bs) (c:cs) = (b, c):(zipDefault def bs cs) diff --git a/hledger-web.1 b/hledger-web.1 --- a/hledger-web.1 +++ b/hledger-web.1 @@ -1,33 +1,37 @@ -.TH "HLEDGER-WEB" "1" "December 2022" "hledger-web-1.28 " "hledger User Manuals" +.TH "HLEDGER-WEB" "1" "March 2023" "hledger-web-1.29 " "hledger User Manuals" .SH NAME .PP -hledger-web is a web interface (WUI) for the hledger accounting tool. -This manual is for hledger-web 1.28. +hledger-web - robust, friendly plain text accounting (Web version) .SH SYNOPSIS .PP -\f[C]hledger-web [OPTIONS] # run temporarily & browse\f[R] +\f[V]hledger-web [OPTIONS] # run temporarily & browse\f[R] .PD 0 .P .PD -\f[C]hledger-web --serve [OPTIONS] # run without stopping\f[R] +\f[V]hledger-web --serve [OPTIONS] # run without stopping\f[R] .PD 0 .P .PD -\f[C]hledger-web --serve-api [OPTIONS] # run JSON server only\f[R] +\f[V]hledger-web --serve-api [OPTIONS] # run JSON server only\f[R] .PD 0 .P .PD +\f[V]hledger web -- [OPTIONS] [QUERYARGS]\f[R] # start from hledger .SH DESCRIPTION .PP -hledger is a reliable, cross-platform set of programs for tracking -money, time, or any other commodity, using double-entry accounting and a -simple, editable file format. -hledger is inspired by and largely compatible with ledger(1). +This manual is for hledger\[aq]s web interface, version 1.29. +See also the hledger manual for common concepts and file formats. .PP +hledger is a robust, user-friendly, cross-platform set of programs for +tracking money, time, or any other commodity, using double-entry +accounting and a simple, editable file format. +hledger is inspired by and largely compatible with ledger(1), and +largely interconvertible with beancount(1). +.PP hledger-web is a simple web application for browsing and adding transactions. It provides a more user-friendly UI than the hledger CLI or hledger-ui @@ -43,10 +47,11 @@ instance, it writes a numbered backup of the main journal file (only) on every edit. .PP -Like hledger, it reads data from one or more files in hledger journal, -timeclock, timedot, or CSV format specified with \f[C]-f\f[R], or -\f[C]$LEDGER_FILE\f[R], or \f[C]$HOME/.hledger.journal\f[R] (on windows, -perhaps \f[C]C:/Users/USER/.hledger.journal\f[R]). +Like hledger, it reads data from one or more files in journal, +timeclock, timedot, or CSV format. +The default file is \f[V].hledger.journal\f[R] in your home directory; +this can be overridden with one or more \f[V]-f FILE\f[R] options, or +the \f[V]LEDGER_FILE\f[R] environment variable. For more about this see hledger(1). .PP hledger-web can be run in three modes: @@ -56,10 +61,10 @@ minutes of inactivity (no requests received and no open browser windows viewing it). .IP \[bu] 2 -With \f[C]--serve\f[R]: the app runs without stopping, and without +With \f[V]--serve\f[R]: the app runs without stopping, and without opening a browser. .IP \[bu] 2 -With \f[C]--serve-api\f[R]: only the JSON API is served. +With \f[V]--serve-api\f[R]: only the JSON API is served. .PP In all cases hledger-web runs as a foreground process, logging requests to stdout. @@ -71,163 +76,164 @@ in addition to any search query entered there. .PP Note: if invoking hledger-web as a hledger subcommand, write -\f[C]--\f[R] before options, as shown in the synopsis above. +\f[V]--\f[R] before options, as shown in the synopsis above. .TP -\f[B]\f[CB]--serve\f[B]\f[R] +\f[V]--serve\f[R] serve and log requests, don\[aq]t browse or auto-exit after timeout .TP -\f[B]\f[CB]--serve-api\f[B]\f[R] +\f[V]--serve-api\f[R] like --serve, but serve only the JSON web API, without the server-side web UI .TP -\f[B]\f[CB]--host=IPADDR\f[B]\f[R] +\f[V]--host=IPADDR\f[R] listen on this IP address (default: 127.0.0.1) .TP -\f[B]\f[CB]--port=PORT\f[B]\f[R] +\f[V]--port=PORT\f[R] listen on this TCP port (default: 5000) .TP -\f[B]\f[CB]--socket=SOCKETFILE\f[B]\f[R] +\f[V]--socket=SOCKETFILE\f[R] use a unix domain socket file to listen for requests instead of a TCP socket. -Implies \f[C]--serve\f[R]. +Implies \f[V]--serve\f[R]. It can only be used if the operating system can provide this type of socket. .TP -\f[B]\f[CB]--base-url=URL\f[B]\f[R] +\f[V]--base-url=URL\f[R] set the base url (default: http://IPADDR:PORT). -You would change this when sharing over the network, or integrating -within a larger website. +Note: affects url generation but not route parsing. +Can be useful if running behind a reverse web proxy that does path +rewriting. .TP -\f[B]\f[CB]--file-url=URL\f[B]\f[R] +\f[V]--file-url=URL\f[R] set the static files url (default: BASEURL/static). hledger-web normally serves static files itself, but if you wanted to serve them from another server for efficiency, you would set the url with this. .TP -\f[B]\f[CB]--capabilities=CAP[,CAP..]\f[B]\f[R] +\f[V]--capabilities=CAP[,CAP..]\f[R] enable the view, add, and/or manage capabilities (default: view,add) .TP -\f[B]\f[CB]--capabilities-header=HTTPHEADER\f[B]\f[R] +\f[V]--capabilities-header=HTTPHEADER\f[R] read capabilities to enable from a HTTP header, like X-Sandstorm-Permissions (default: disabled) .TP -\f[B]\f[CB]--test\f[B]\f[R] +\f[V]--test\f[R] run hledger-web\[aq]s tests and exit. hspec test runner args may follow a --, eg: hledger-web --test -- --help .PP hledger input options: .TP -\f[B]\f[CB]-f FILE --file=FILE\f[B]\f[R] +\f[V]-f FILE --file=FILE\f[R] use a different input file. -For stdin, use - (default: \f[C]$LEDGER_FILE\f[R] or -\f[C]$HOME/.hledger.journal\f[R]) +For stdin, use - (default: \f[V]$LEDGER_FILE\f[R] or +\f[V]$HOME/.hledger.journal\f[R]) .TP -\f[B]\f[CB]--rules-file=RULESFILE\f[B]\f[R] +\f[V]--rules-file=RULESFILE\f[R] Conversion rules file to use when reading CSV (default: FILE.rules) .TP -\f[B]\f[CB]--separator=CHAR\f[B]\f[R] +\f[V]--separator=CHAR\f[R] Field separator to expect when reading CSV (default: \[aq],\[aq]) .TP -\f[B]\f[CB]--alias=OLD=NEW\f[B]\f[R] +\f[V]--alias=OLD=NEW\f[R] rename accounts named OLD to NEW .TP -\f[B]\f[CB]--anon\f[B]\f[R] +\f[V]--anon\f[R] anonymize accounts and payees .TP -\f[B]\f[CB]--pivot FIELDNAME\f[B]\f[R] +\f[V]--pivot FIELDNAME\f[R] use some other field or tag for the account name .TP -\f[B]\f[CB]-I --ignore-assertions\f[B]\f[R] +\f[V]-I --ignore-assertions\f[R] disable balance assertion checks (note: does not disable balance assignments) .TP -\f[B]\f[CB]-s --strict\f[B]\f[R] +\f[V]-s --strict\f[R] do extra error checking (check that all posted accounts are declared) .PP hledger reporting options: .TP -\f[B]\f[CB]-b --begin=DATE\f[B]\f[R] +\f[V]-b --begin=DATE\f[R] include postings/txns on or after this date (will be adjusted to preceding subperiod start when using a report interval) .TP -\f[B]\f[CB]-e --end=DATE\f[B]\f[R] +\f[V]-e --end=DATE\f[R] include postings/txns before this date (will be adjusted to following subperiod end when using a report interval) .TP -\f[B]\f[CB]-D --daily\f[B]\f[R] +\f[V]-D --daily\f[R] multiperiod/multicolumn report by day .TP -\f[B]\f[CB]-W --weekly\f[B]\f[R] +\f[V]-W --weekly\f[R] multiperiod/multicolumn report by week .TP -\f[B]\f[CB]-M --monthly\f[B]\f[R] +\f[V]-M --monthly\f[R] multiperiod/multicolumn report by month .TP -\f[B]\f[CB]-Q --quarterly\f[B]\f[R] +\f[V]-Q --quarterly\f[R] multiperiod/multicolumn report by quarter .TP -\f[B]\f[CB]-Y --yearly\f[B]\f[R] +\f[V]-Y --yearly\f[R] multiperiod/multicolumn report by year .TP -\f[B]\f[CB]-p --period=PERIODEXP\f[B]\f[R] +\f[V]-p --period=PERIODEXP\f[R] set start date, end date, and/or reporting interval all at once using period expressions syntax .TP -\f[B]\f[CB]--date2\f[B]\f[R] +\f[V]--date2\f[R] match the secondary date instead (see command help for other effects) .TP -\f[B]\f[CB]--today=DATE\f[B]\f[R] +\f[V]--today=DATE\f[R] override today\[aq]s date (affects relative smart dates, for tests/examples) .TP -\f[B]\f[CB]-U --unmarked\f[B]\f[R] +\f[V]-U --unmarked\f[R] include only unmarked postings/txns (can combine with -P or -C) .TP -\f[B]\f[CB]-P --pending\f[B]\f[R] +\f[V]-P --pending\f[R] include only pending postings/txns .TP -\f[B]\f[CB]-C --cleared\f[B]\f[R] +\f[V]-C --cleared\f[R] include only cleared postings/txns .TP -\f[B]\f[CB]-R --real\f[B]\f[R] +\f[V]-R --real\f[R] include only non-virtual postings .TP -\f[B]\f[CB]-NUM --depth=NUM\f[B]\f[R] +\f[V]-NUM --depth=NUM\f[R] hide/aggregate accounts or postings more than NUM levels deep .TP -\f[B]\f[CB]-E --empty\f[B]\f[R] +\f[V]-E --empty\f[R] show items with zero amount, normally hidden (and vice-versa in hledger-ui/hledger-web) .TP -\f[B]\f[CB]-B --cost\f[B]\f[R] +\f[V]-B --cost\f[R] convert amounts to their cost/selling amount at transaction time .TP -\f[B]\f[CB]-V --market\f[B]\f[R] +\f[V]-V --market\f[R] convert amounts to their market value in default valuation commodities .TP -\f[B]\f[CB]-X --exchange=COMM\f[B]\f[R] +\f[V]-X --exchange=COMM\f[R] convert amounts to their market value in commodity COMM .TP -\f[B]\f[CB]--value\f[B]\f[R] +\f[V]--value\f[R] convert amounts to cost or market value, more flexibly than -B/-V/-X .TP -\f[B]\f[CB]--infer-market-prices\f[B]\f[R] +\f[V]--infer-market-prices\f[R] use transaction prices (recorded with \[at] or \[at]\[at]) as additional market prices, as if they were P directives .TP -\f[B]\f[CB]--auto\f[B]\f[R] +\f[V]--auto\f[R] apply automated posting rules to modify transactions. .TP -\f[B]\f[CB]--forecast\f[B]\f[R] +\f[V]--forecast\f[R] generate future transactions from periodic transaction rules, for the next 6 months or till report end date. In hledger-ui, also make ordinary future transactions visible. .TP -\f[B]\f[CB]--commodity-style\f[B]\f[R] +\f[V]--commodity-style\f[R] Override the commodity style in the output for the specified commodity. For example \[aq]EUR1.000,00\[aq]. .TP -\f[B]\f[CB]--color=WHEN (or --colour=WHEN)\f[B]\f[R] +\f[V]--color=WHEN (or --colour=WHEN)\f[R] Should color-supporting commands use ANSI color codes in text output. \[aq]auto\[aq] (default): whenever stdout seems to be a color-supporting terminal. @@ -236,7 +242,7 @@ \[aq]never\[aq] or \[aq]no\[aq]: never. A NO_COLOR environment variable overrides this. .TP -\f[B]\f[CB]--pretty[=WHEN]\f[B]\f[R] +\f[V]--pretty[=WHEN]\f[R] Show prettier output, e.g. using unicode box-drawing characters. Accepts \[aq]yes\[aq] (the default) or \[aq]no\[aq] (\[aq]y\[aq], @@ -251,46 +257,46 @@ .PP hledger help options: .TP -\f[B]\f[CB]-h --help\f[B]\f[R] +\f[V]-h --help\f[R] show general or COMMAND help .TP -\f[B]\f[CB]--man\f[B]\f[R] +\f[V]--man\f[R] show general or COMMAND user manual with man .TP -\f[B]\f[CB]--info\f[B]\f[R] +\f[V]--info\f[R] show general or COMMAND user manual with info .TP -\f[B]\f[CB]--version\f[B]\f[R] +\f[V]--version\f[R] show general or ADDONCMD version .TP -\f[B]\f[CB]--debug[=N]\f[B]\f[R] +\f[V]--debug[=N]\f[R] show debug output (levels 1-9, default: 1) .PP A \[at]FILE argument will be expanded to the contents of FILE, which should contain one command line option/argument per line. -(To prevent this, insert a \f[C]--\f[R] argument before.) +(To prevent this, insert a \f[V]--\f[R] argument before.) .PP By default the server listens on IP address 127.0.0.1, accessible only to local requests. -You can use \f[C]--host\f[R] to change this, eg \f[C]--host 0.0.0.0\f[R] +You can use \f[V]--host\f[R] to change this, eg \f[V]--host 0.0.0.0\f[R] to listen on all configured addresses. .PP -Similarly, use \f[C]--port\f[R] to set a TCP port other than 5000, eg if +Similarly, use \f[V]--port\f[R] to set a TCP port other than 5000, eg if you are running multiple hledger-web instances. .PP -Both of these options are ignored when \f[C]--socket\f[R] is used. -In this case, it creates an \f[C]AF_UNIX\f[R] socket file at the +Both of these options are ignored when \f[V]--socket\f[R] is used. +In this case, it creates an \f[V]AF_UNIX\f[R] socket file at the supplied path and uses that for communication. This is an alternative way of running multiple hledger-web instances behind a reverse proxy that handles authentication for different users. The path can be derived in a predictable way, eg by using the username within the path. -As an example, \f[C]nginx\f[R] as reverse proxy can use the variable -\f[C]$remote_user\f[R] to derive a path from the username used in a HTTP +As an example, \f[V]nginx\f[R] as reverse proxy can use the variable +\f[V]$remote_user\f[R] to derive a path from the username used in a HTTP basic authentication. -The following \f[C]proxy_pass\f[R] directive allows access to all -\f[C]hledger-web\f[R] instances that created a socket in -\f[C]/tmp/hledger/\f[R]: +The following \f[V]proxy_pass\f[R] directive allows access to all +\f[V]hledger-web\f[R] instances that created a socket in +\f[V]/tmp/hledger/\f[R]: .IP .nf \f[C] @@ -298,14 +304,14 @@ \f[R] .fi .PP -You can use \f[C]--base-url\f[R] to change the protocol, hostname, port +You can use \f[V]--base-url\f[R] to change the protocol, hostname, port and path that appear in hyperlinks, useful eg for integrating hledger-web within a larger website. -The default is \f[C]http://HOST:PORT/\f[R] using the server\[aq]s -configured host address and TCP port (or \f[C]http://HOST\f[R] if PORT +The default is \f[V]http://HOST:PORT/\f[R] using the server\[aq]s +configured host address and TCP port (or \f[V]http://HOST\f[R] if PORT is 80). .PP -With \f[C]--file-url\f[R] you can set a different base url for static +With \f[V]--file-url\f[R] you can set a different base url for static files, eg for better caching or cookie-less serving on high performance websites. .SH PERMISSIONS @@ -315,7 +321,7 @@ .PP You can restrict who can reach it by .IP \[bu] 2 -setting the IP address it listens on (see \f[C]--host\f[R] above). +setting the IP address it listens on (see \f[V]--host\f[R] above). By default it listens on 127.0.0.1, accessible to all users on the local machine. .IP \[bu] 2 @@ -325,27 +331,27 @@ .PP You can restrict what the users who reach it can do, by .IP \[bu] 2 -using the \f[C]--capabilities=CAP[,CAP..]\f[R] flag when you start it, +using the \f[V]--capabilities=CAP[,CAP..]\f[R] flag when you start it, enabling one or more of the following capabilities. -The default value is \f[C]view,add\f[R]: +The default value is \f[V]view,add\f[R]: .RS 2 .IP \[bu] 2 -\f[C]view\f[R] - allows viewing the journal file and all included files +\f[V]view\f[R] - allows viewing the journal file and all included files .IP \[bu] 2 -\f[C]add\f[R] - allows adding new transactions to the main journal file +\f[V]add\f[R] - allows adding new transactions to the main journal file .IP \[bu] 2 -\f[C]manage\f[R] - allows editing, uploading or downloading the main or +\f[V]manage\f[R] - allows editing, uploading or downloading the main or included files .RE .IP \[bu] 2 -using the \f[C]--capabilities-header=HTTPHEADER\f[R] flag to specify a +using the \f[V]--capabilities-header=HTTPHEADER\f[R] flag to specify a HTTP header from which it will read capabilities to enable. hledger-web on Sandstorm uses the X-Sandstorm-Permissions header to integrate with Sandstorm\[aq]s permissions. This is disabled by default. .SH EDITING, UPLOADING, DOWNLOADING .PP -If you enable the \f[C]manage\f[R] capability mentioned above, +If you enable the \f[V]manage\f[R] capability mentioned above, you\[aq]ll see a new \[dq]spanner\[dq] button to the right of the search form. Clicking this will let you edit, upload, or download the journal file or @@ -356,9 +362,10 @@ .PP Normally whenever a file is changed in this way, hledger-web saves a numbered backup (assuming file permissions allow it, the disk is not -full, etc.) hledger-web is not aware of version control systems, -currently; if you use one, you\[aq]ll have to arrange to commit the -changes yourself (eg with a cron job or a file watcher like entr). +full, etc.) +hledger-web is not aware of version control systems, currently; if you +use one, you\[aq]ll have to arrange to commit the changes yourself (eg +with a cron job or a file watcher like entr). .PP Changes which would leave the journal file(s) unparseable or non-valid (eg with failing balance assertions) are prevented. @@ -378,7 +385,7 @@ .PP In addition to the web UI, hledger-web also serves a JSON API that can be used to get data or add new transactions. -If you want the JSON API only, you can use the \f[C]--serve-api\f[R] +If you want the JSON API only, you can use the \f[V]--serve-api\f[R] flag. Eg: .IP @@ -456,25 +463,25 @@ Most of the JSON corresponds to hledger\[aq]s data types; for details of what the fields mean, see the Hledger.Data.Json haddock docs and click on the various data types, eg Transaction. -And for a higher level understanding, see the journal manual. +And for a higher level understanding, see the journal docs. .PP In some cases there is outer JSON corresponding to a \[dq]Report\[dq] type. To understand that, go to the Hledger.Web.Handler.MiscR haddock and look at the source for the appropriate handler to see what it returns. -Eg for \f[C]/accounttransactions\f[R] it\[aq]s getAccounttransactionsR, -returning a \[dq]\f[C]accountTransactionsReport ...\f[R]\[dq]. +Eg for \f[V]/accounttransactions\f[R] it\[aq]s getAccounttransactionsR, +returning a \[dq]\f[V]accountTransactionsReport ...\f[R]\[dq]. Looking up the haddock for that we can see that /accounttransactions returns an AccountTransactionsReport, which consists of a report title and a list of AccountTransactionsReportItem (etc). .PP You can add a new transaction to the journal with a PUT request to -\f[C]/add\f[R], if hledger-web was started with the \f[C]add\f[R] +\f[V]/add\f[R], if hledger-web was started with the \f[V]add\f[R] capability (enabled by default). The payload must be the full, exact JSON representation of a hledger transaction (partial data won\[aq]t do). -You can get sample JSON from hledger-web\[aq]s \f[C]/transactions\f[R] -or \f[C]/accounttransactions\f[R], or you can export it with +You can get sample JSON from hledger-web\[aq]s \f[V]/transactions\f[R] +or \f[V]/accounttransactions\f[R], or you can export it with hledger-lib, eg like so: .IP .nf @@ -589,7 +596,7 @@ .SH DEBUG OUTPUT .SS Debug output .PP -You can add \f[C]--debug[=N]\f[R] to the command line to log debug +You can add \f[V]--debug[=N]\f[R] to the command line to log debug output. N ranges from 1 (least output, the default) to 9 (maximum output). Typically you would start with 1 and increase until you are seeing @@ -601,23 +608,23 @@ .PD 0 .P .PD -\f[C]hledger-web --debug=3 2>hledger-web.log\f[R]. +\f[V]hledger-web --debug=3 2>hledger-web.log\f[R]. .SH ENVIRONMENT .PP \f[B]LEDGER_FILE\f[R] The journal file path when not specified with -\f[C]-f\f[R]. +\f[V]-f\f[R]. .PP On unix computers, the default value is: -\f[C]\[ti]/.hledger.journal\f[R]. +\f[V]\[ti]/.hledger.journal\f[R]. .PP A more typical value is something like -\f[C]\[ti]/finance/YYYY.journal\f[R], where \f[C]\[ti]/finance\f[R] is a +\f[V]\[ti]/finance/YYYY.journal\f[R], where \f[V]\[ti]/finance\f[R] is a version-controlled finance directory and YYYY is the current year. -Or, \f[C]\[ti]/finance/current.journal\f[R], where current.journal is a +Or, \f[V]\[ti]/finance/current.journal\f[R], where current.journal is a symbolic link to YYYY.journal. .PP The usual way to set this permanently is to add a command to one of your -shell\[aq]s startup files (eg \f[C]\[ti]/.profile\f[R]): +shell\[aq]s startup files (eg \f[V]\[ti]/.profile\f[R]): .IP .nf \f[C] @@ -628,7 +635,7 @@ On some Mac computers, there is a more thorough way to set environment variables, that will also affect applications started from the GUI (eg, Emacs started from a dock icon): In -\f[C]\[ti]/.MacOSX/environment.plist\f[R], add an entry like: +\f[V]\[ti]/.MacOSX/environment.plist\f[R], add an entry like: .IP .nf \f[C] @@ -638,11 +645,11 @@ \f[R] .fi .PP -For this to take effect you might need to \f[C]killall Dock\f[R], or +For this to take effect you might need to \f[V]killall Dock\f[R], or reboot. .PP On Windows computers, the default value is probably -\f[C]C:\[rs]Users\[rs]YOURNAME\[rs].hledger.journal\f[R]. +\f[V]C:\[rs]Users\[rs]YOURNAME\[rs].hledger.journal\f[R]. You can change this by running a command like this in a powershell window (let us know if you need to be an Administrator, and if this persists across a reboot): @@ -657,16 +664,14 @@ https://www.java.com/en/download/help/path.html. .SH FILES .PP -Reads data from one or more files in hledger journal, timeclock, -timedot, or CSV format specified with \f[C]-f\f[R], or -\f[C]$LEDGER_FILE\f[R], or \f[C]$HOME/.hledger.journal\f[R] (on windows, -perhaps \f[C]C:/Users/USER/.hledger.journal\f[R]). +Reads data from one or more files in journal, timeclock, timedot, or CSV +format. +The default file is \f[V].hledger.journal\f[R] in your home directory; +this can be overridden with one or more \f[V]-f FILE\f[R] options, or +the \f[V]LEDGER_FILE\f[R] environment variable. .SH BUGS .PP -The need to precede options with \f[C]--\f[R] when invoked from hledger -is awkward. -.PP -\f[C]-f-\f[R] doesn\[aq]t work (hledger-web can\[aq]t read from stdin). +\f[V]-f-\f[R] doesn\[aq]t work (hledger-web can\[aq]t read from stdin). .PP Query arguments and some hledger options are ignored. .PP @@ -677,15 +682,17 @@ .SH "REPORTING BUGS" Report bugs at http://bugs.hledger.org -(or on the #hledger IRC channel or hledger mail list) +(or on the #hledger chat or hledger mail list) .SH AUTHORS -Simon Michael and contributors +Simon Michael and contributors. +.br +See http://hledger.org/CREDITS.html .SH COPYRIGHT +Copyright 2007-2023 Simon Michael and contributors. -Copyright (C) 2007-2020 Simon Michael. -.br +.SH LICENSE Released under GNU GPL v3 or later. .SH SEE ALSO diff --git a/hledger-web.cabal b/hledger-web.cabal --- a/hledger-web.cabal +++ b/hledger-web.cabal @@ -1,11 +1,11 @@ cabal-version: 1.12 --- This file has been generated from package.yaml by hpack version 0.35.0. +-- This file has been generated from package.yaml by hpack version 0.35.1. -- -- see: https://github.com/sol/hpack name: hledger-web -version: 1.28 +version: 1.29 synopsis: Web-based user interface for the hledger accounting system description: A simple web-based user interface for the hledger accounting system, providing a more modern UI than the command-line or terminal interfaces. @@ -151,7 +151,7 @@ hs-source-dirs: ./ ghc-options: -Wall -Wredundant-constraints -Wincomplete-record-updates -Wincomplete-uni-patterns - cpp-options: -DVERSION="1.28" + cpp-options: -DVERSION="1.29" build-depends: Decimal >=0.5.1 , aeson >=1 @@ -171,8 +171,8 @@ , extra >=1.6.3 , filepath , hjsmin - , hledger ==1.28.* - , hledger-lib ==1.28.* + , hledger ==1.29.* + , hledger-lib ==1.29.* , hspec , http-client , http-conduit @@ -212,7 +212,7 @@ hs-source-dirs: app ghc-options: -Wall -Wredundant-constraints -Wincomplete-record-updates -Wincomplete-uni-patterns - cpp-options: -DVERSION="1.28" + cpp-options: -DVERSION="1.29" build-depends: base >=4.14 && <4.18 , hledger-web @@ -232,7 +232,7 @@ hs-source-dirs: test ghc-options: -Wall -Wredundant-constraints -Wincomplete-record-updates -Wincomplete-uni-patterns - cpp-options: -DVERSION="1.28" + cpp-options: -DVERSION="1.29" build-depends: base >=4.14 && <4.18 , hledger diff --git a/hledger-web.info b/hledger-web.info --- a/hledger-web.info +++ b/hledger-web.info @@ -1,4 +1,4 @@ -This is hledger-web.info, produced by makeinfo version 6.8 from stdin. +This is hledger-web.info, produced by makeinfo version 7.0.1 from stdin. INFO-DIR-SECTION User Applications START-INFO-DIR-ENTRY @@ -11,18 +11,22 @@ hledger-web(1) ************** -hledger-web is a web interface (WUI) for the hledger accounting tool. -This manual is for hledger-web 1.28. +hledger-web - robust, friendly plain text accounting (Web version) - 'hledger-web [OPTIONS] # run temporarily & browse' -'hledger-web --serve [OPTIONS] # run without stopping' -'hledger-web --serve-api [OPTIONS] # run JSON server only' + ‘hledger-web [OPTIONS] # run temporarily & browse’ +‘hledger-web --serve [OPTIONS] # run without stopping’ +‘hledger-web --serve-api [OPTIONS] # run JSON server only’ +‘hledger web -- [OPTIONS] [QUERYARGS]’ # start from hledger - hledger is a reliable, cross-platform set of programs for tracking -money, time, or any other commodity, using double-entry accounting and a -simple, editable file format. hledger is inspired by and largely -compatible with ledger(1). + This manual is for hledger’s web interface, version 1.29. See also +the hledger manual for common concepts and file formats. + hledger is a robust, user-friendly, cross-platform set of programs +for tracking money, time, or any other commodity, using double-entry +accounting and a simple, editable file format. hledger is inspired by +and largely compatible with ledger(1), and largely interconvertible with +beancount(1). + hledger-web is a simple web application for browsing and adding transactions. It provides a more user-friendly UI than the hledger CLI or hledger-ui TUI, showing more at once (accounts, the current account @@ -35,22 +39,23 @@ against data loss when running an unprotected instance, it writes a numbered backup of the main journal file (only) on every edit. - Like hledger, it reads data from one or more files in hledger -journal, timeclock, timedot, or CSV format specified with '-f', or -'$LEDGER_FILE', or '$HOME/.hledger.journal' (on windows, perhaps -'C:/Users/USER/.hledger.journal'). For more about this see hledger(1). + Like hledger, it reads data from one or more files in journal, +timeclock, timedot, or CSV format. The default file is +‘.hledger.journal’ in your home directory; this can be overridden with +one or more ‘-f FILE’ options, or the ‘LEDGER_FILE’ environment +variable. For more about this see hledger(1). hledger-web can be run in three modes: - * Transient mode (the default): your default web browser will be + • Transient mode (the default): your default web browser will be opened to show the app if possible, and the app exits automatically after two minutes of inactivity (no requests received and no open browser windows viewing it). - * With '--serve': the app runs without stopping, and without opening + • With ‘--serve’: the app runs without stopping, and without opening a browser. - * With '--serve-api': only the JSON API is served. + • With ‘--serve-api’: only the JSON API is served. In all cases hledger-web runs as a foreground process, logging requests to stdout. @@ -77,180 +82,180 @@ on the data. These filter options are not shown in the web UI, but it will be applied in addition to any search query entered there. - Note: if invoking hledger-web as a hledger subcommand, write '--' + Note: if invoking hledger-web as a hledger subcommand, write ‘--’ before options, as shown in the synopsis above. -'--serve' +‘--serve’ - serve and log requests, don't browse or auto-exit after timeout -'--serve-api' + serve and log requests, don’t browse or auto-exit after timeout +‘--serve-api’ - like -serve, but serve only the JSON web API, without the + like –serve, but serve only the JSON web API, without the server-side web UI -'--host=IPADDR' +‘--host=IPADDR’ listen on this IP address (default: 127.0.0.1) -'--port=PORT' +‘--port=PORT’ listen on this TCP port (default: 5000) -'--socket=SOCKETFILE' +‘--socket=SOCKETFILE’ use a unix domain socket file to listen for requests instead of a - TCP socket. Implies '--serve'. It can only be used if the + TCP socket. Implies ‘--serve’. It can only be used if the operating system can provide this type of socket. -'--base-url=URL' +‘--base-url=URL’ - set the base url (default: http://IPADDR:PORT). You would change - this when sharing over the network, or integrating within a larger - website. -'--file-url=URL' + set the base url (default: http://IPADDR:PORT). Note: affects url + generation but not route parsing. Can be useful if running behind + a reverse web proxy that does path rewriting. +‘--file-url=URL’ set the static files url (default: BASEURL/static). hledger-web normally serves static files itself, but if you wanted to serve them from another server for efficiency, you would set the url with this. -'--capabilities=CAP[,CAP..]' +‘--capabilities=CAP[,CAP..]’ enable the view, add, and/or manage capabilities (default: view,add) -'--capabilities-header=HTTPHEADER' +‘--capabilities-header=HTTPHEADER’ read capabilities to enable from a HTTP header, like X-Sandstorm-Permissions (default: disabled) -'--test' +‘--test’ - run hledger-web's tests and exit. hspec test runner args may - follow a -, eg: hledger-web -test - -help + run hledger-web’s tests and exit. hspec test runner args may + follow a –, eg: hledger-web –test – –help hledger input options: -'-f FILE --file=FILE' +‘-f FILE --file=FILE’ use a different input file. For stdin, use - (default: - '$LEDGER_FILE' or '$HOME/.hledger.journal') -'--rules-file=RULESFILE' + ‘$LEDGER_FILE’ or ‘$HOME/.hledger.journal’) +‘--rules-file=RULESFILE’ Conversion rules file to use when reading CSV (default: FILE.rules) -'--separator=CHAR' +‘--separator=CHAR’ - Field separator to expect when reading CSV (default: ',') -'--alias=OLD=NEW' + Field separator to expect when reading CSV (default: ’,’) +‘--alias=OLD=NEW’ rename accounts named OLD to NEW -'--anon' +‘--anon’ anonymize accounts and payees -'--pivot FIELDNAME' +‘--pivot FIELDNAME’ use some other field or tag for the account name -'-I --ignore-assertions' +‘-I --ignore-assertions’ disable balance assertion checks (note: does not disable balance assignments) -'-s --strict' +‘-s --strict’ do extra error checking (check that all posted accounts are declared) hledger reporting options: -'-b --begin=DATE' +‘-b --begin=DATE’ include postings/txns on or after this date (will be adjusted to preceding subperiod start when using a report interval) -'-e --end=DATE' +‘-e --end=DATE’ include postings/txns before this date (will be adjusted to following subperiod end when using a report interval) -'-D --daily' +‘-D --daily’ multiperiod/multicolumn report by day -'-W --weekly' +‘-W --weekly’ multiperiod/multicolumn report by week -'-M --monthly' +‘-M --monthly’ multiperiod/multicolumn report by month -'-Q --quarterly' +‘-Q --quarterly’ multiperiod/multicolumn report by quarter -'-Y --yearly' +‘-Y --yearly’ multiperiod/multicolumn report by year -'-p --period=PERIODEXP' +‘-p --period=PERIODEXP’ set start date, end date, and/or reporting interval all at once using period expressions syntax -'--date2' +‘--date2’ match the secondary date instead (see command help for other effects) -'--today=DATE' +‘--today=DATE’ - override today's date (affects relative smart dates, for + override today’s date (affects relative smart dates, for tests/examples) -'-U --unmarked' +‘-U --unmarked’ include only unmarked postings/txns (can combine with -P or -C) -'-P --pending' +‘-P --pending’ include only pending postings/txns -'-C --cleared' +‘-C --cleared’ include only cleared postings/txns -'-R --real' +‘-R --real’ include only non-virtual postings -'-NUM --depth=NUM' +‘-NUM --depth=NUM’ hide/aggregate accounts or postings more than NUM levels deep -'-E --empty' +‘-E --empty’ show items with zero amount, normally hidden (and vice-versa in hledger-ui/hledger-web) -'-B --cost' +‘-B --cost’ convert amounts to their cost/selling amount at transaction time -'-V --market' +‘-V --market’ convert amounts to their market value in default valuation commodities -'-X --exchange=COMM' +‘-X --exchange=COMM’ convert amounts to their market value in commodity COMM -'--value' +‘--value’ convert amounts to cost or market value, more flexibly than -B/-V/-X -'--infer-market-prices' +‘--infer-market-prices’ use transaction prices (recorded with @ or @@) as additional market prices, as if they were P directives -'--auto' +‘--auto’ apply automated posting rules to modify transactions. -'--forecast' +‘--forecast’ generate future transactions from periodic transaction rules, for the next 6 months or till report end date. In hledger-ui, also make ordinary future transactions visible. -'--commodity-style' +‘--commodity-style’ Override the commodity style in the output for the specified - commodity. For example 'EUR1.000,00'. -'--color=WHEN (or --colour=WHEN)' + commodity. For example ’EUR1.000,00’. +‘--color=WHEN (or --colour=WHEN)’ Should color-supporting commands use ANSI color codes in text - output. 'auto' (default): whenever stdout seems to be a - color-supporting terminal. 'always' or 'yes': always, useful eg - when piping output into 'less -R'. 'never' or 'no': never. A + output. ’auto’ (default): whenever stdout seems to be a + color-supporting terminal. ’always’ or ’yes’: always, useful eg + when piping output into ’less -R’. ’never’ or ’no’: never. A NO_COLOR environment variable overrides this. -'--pretty[=WHEN]' +‘--pretty[=WHEN]’ Show prettier output, e.g. using unicode box-drawing characters. - Accepts 'yes' (the default) or 'no' ('y', 'n', 'always', 'never' - also work). If you provide an argument you must use '=', e.g. - '-pretty=yes'. + Accepts ’yes’ (the default) or ’no’ (’y’, ’n’, ’always’, ’never’ + also work). If you provide an argument you must use ’=’, e.g. + ’–pretty=yes’. When a reporting option appears more than once in the command line, the last one takes precedence. @@ -259,53 +264,53 @@ hledger help options: -'-h --help' +‘-h --help’ show general or COMMAND help -'--man' +‘--man’ show general or COMMAND user manual with man -'--info' +‘--info’ show general or COMMAND user manual with info -'--version' +‘--version’ show general or ADDONCMD version -'--debug[=N]' +‘--debug[=N]’ show debug output (levels 1-9, default: 1) A @FILE argument will be expanded to the contents of FILE, which should contain one command line option/argument per line. (To prevent -this, insert a '--' argument before.) +this, insert a ‘--’ argument before.) By default the server listens on IP address 127.0.0.1, accessible -only to local requests. You can use '--host' to change this, eg '--host -0.0.0.0' to listen on all configured addresses. +only to local requests. You can use ‘--host’ to change this, eg ‘--host +0.0.0.0’ to listen on all configured addresses. - Similarly, use '--port' to set a TCP port other than 5000, eg if you + Similarly, use ‘--port’ to set a TCP port other than 5000, eg if you are running multiple hledger-web instances. - Both of these options are ignored when '--socket' is used. In this -case, it creates an 'AF_UNIX' socket file at the supplied path and uses + Both of these options are ignored when ‘--socket’ is used. In this +case, it creates an ‘AF_UNIX’ socket file at the supplied path and uses that for communication. This is an alternative way of running multiple hledger-web instances behind a reverse proxy that handles authentication for different users. The path can be derived in a predictable way, eg -by using the username within the path. As an example, 'nginx' as -reverse proxy can use the variable '$remote_user' to derive a path from +by using the username within the path. As an example, ‘nginx’ as +reverse proxy can use the variable ‘$remote_user’ to derive a path from the username used in a HTTP basic authentication. The following -'proxy_pass' directive allows access to all 'hledger-web' instances that -created a socket in '/tmp/hledger/': +‘proxy_pass’ directive allows access to all ‘hledger-web’ instances that +created a socket in ‘/tmp/hledger/’: proxy_pass http://unix:/tmp/hledger/${remote_user}.socket; - You can use '--base-url' to change the protocol, hostname, port and + You can use ‘--base-url’ to change the protocol, hostname, port and path that appear in hyperlinks, useful eg for integrating hledger-web -within a larger website. The default is 'http://HOST:PORT/' using the -server's configured host address and TCP port (or 'http://HOST' if PORT +within a larger website. The default is ‘http://HOST:PORT/’ using the +server’s configured host address and TCP port (or ‘http://HOST’ if PORT is 80). - With '--file-url' you can set a different base url for static files, + With ‘--file-url’ you can set a different base url for static files, eg for better caching or cookie-less serving on high performance websites. @@ -320,28 +325,28 @@ You can restrict who can reach it by - * setting the IP address it listens on (see '--host' above). By + • setting the IP address it listens on (see ‘--host’ above). By default it listens on 127.0.0.1, accessible to all users on the local machine. - * putting it behind an authenticating proxy, using eg apache or nginx - * custom firewall rules + • putting it behind an authenticating proxy, using eg apache or nginx + • custom firewall rules You can restrict what the users who reach it can do, by - * using the '--capabilities=CAP[,CAP..]' flag when you start it, + • using the ‘--capabilities=CAP[,CAP..]’ flag when you start it, enabling one or more of the following capabilities. The default - value is 'view,add': - * 'view' - allows viewing the journal file and all included + value is ‘view,add’: + • ‘view’ - allows viewing the journal file and all included files - * 'add' - allows adding new transactions to the main journal + • ‘add’ - allows adding new transactions to the main journal file - * 'manage' - allows editing, uploading or downloading the main + • ‘manage’ - allows editing, uploading or downloading the main or included files - * using the '--capabilities-header=HTTPHEADER' flag to specify a HTTP + • using the ‘--capabilities-header=HTTPHEADER’ flag to specify a HTTP header from which it will read capabilities to enable. hledger-web on Sandstorm uses the X-Sandstorm-Permissions header to integrate - with Sandstorm's permissions. This is disabled by default. + with Sandstorm’s permissions. This is disabled by default.  File: hledger-web.info, Node: EDITING UPLOADING DOWNLOADING, Next: RELOADING, Prev: PERMISSIONS, Up: Top @@ -349,7 +354,7 @@ 3 EDITING, UPLOADING, DOWNLOADING ********************************* -If you enable the 'manage' capability mentioned above, you'll see a new +If you enable the ‘manage’ capability mentioned above, you’ll see a new "spanner" button to the right of the search form. Clicking this will let you edit, upload, or download the journal file or any files it includes. @@ -360,7 +365,7 @@ Normally whenever a file is changed in this way, hledger-web saves a numbered backup (assuming file permissions allow it, the disk is not full, etc.) hledger-web is not aware of version control systems, -currently; if you use one, you'll have to arrange to commit the changes +currently; if you use one, you’ll have to arrange to commit the changes yourself (eg with a cron job or a file watcher like entr). Changes which would leave the journal file(s) unparseable or @@ -390,7 +395,7 @@ In addition to the web UI, hledger-web also serves a JSON API that can be used to get data or add new transactions. If you want the JSON API -only, you can use the '--serve-api' flag. Eg: +only, you can use the ‘--serve-api’ flag. Eg: $ hledger-web -f examples/sample.journal --serve-api ... @@ -406,7 +411,7 @@ /accounttransactions/ACCOUNTNAME Eg, all account names in the journal (similar to the accounts -command). (hledger-web's JSON does not include newlines, here we use +command). (hledger-web’s JSON does not include newlines, here we use python to prettify it): $ curl -s http://127.0.0.1:5000/accountnames | python -m json.tool @@ -447,33 +452,33 @@ "aprice": null, ... - Most of the JSON corresponds to hledger's data types; for details of + Most of the JSON corresponds to hledger’s data types; for details of what the fields mean, see the Hledger.Data.Json haddock docs and click on the various data types, eg Transaction. And for a higher level -understanding, see the journal manual. +understanding, see the journal docs. In some cases there is outer JSON corresponding to a "Report" type. To understand that, go to the Hledger.Web.Handler.MiscR haddock and look at the source for the appropriate handler to see what it returns. Eg -for '/accounttransactions' it's getAccounttransactionsR, returning a -"'accountTransactionsReport ...'". Looking up the haddock for that we +for ‘/accounttransactions’ it’s getAccounttransactionsR, returning a +"‘accountTransactionsReport ...’". Looking up the haddock for that we can see that /accounttransactions returns an AccountTransactionsReport, which consists of a report title and a list of AccountTransactionsReportItem (etc). You can add a new transaction to the journal with a PUT request to -'/add', if hledger-web was started with the 'add' capability (enabled by +‘/add’, if hledger-web was started with the ‘add’ capability (enabled by default). The payload must be the full, exact JSON representation of a -hledger transaction (partial data won't do). You can get sample JSON -from hledger-web's '/transactions' or '/accounttransactions', or you can +hledger transaction (partial data won’t do). You can get sample JSON +from hledger-web’s ‘/transactions’ or ‘/accounttransactions’, or you can export it with hledger-lib, eg like so: .../hledger$ stack ghci hledger-lib >>> writeJsonFile "txn.json" (head $ jtxns samplejournal) >>> :q - Here's how it looks as of hledger-1.17 (remember, this JSON -corresponds to hledger's Transaction and related data types): + Here’s how it looks as of hledger-1.17 (remember, this JSON +corresponds to hledger’s Transaction and related data types): { "tcomment": "", @@ -561,7 +566,7 @@ "tstatus": "Unmarked" } - And here's how to test adding it with curl. This should add a new + And here’s how to test adding it with curl. This should add a new entry to your journal: $ curl http://127.0.0.1:5000/add -X PUT -H 'Content-Type: application/json' --data-binary @txn.json @@ -582,13 +587,13 @@ 6.1 Debug output ================ -You can add '--debug[=N]' to the command line to log debug output. N +You can add ‘--debug[=N]’ to the command line to log debug output. N ranges from 1 (least output, the default) to 9 (maximum output). Typically you would start with 1 and increase until you are seeing enough. Debug output goes to stderr, interleaved with the requests logged on stdout. To capture debug output in a log file instead, you can usually redirect stderr, eg: -'hledger-web --debug=3 2>hledger-web.log'. +‘hledger-web --debug=3 2>hledger-web.log’.  File: hledger-web.info, Node: ENVIRONMENT, Next: FILES, Prev: DEBUG OUTPUT, Up: Top @@ -596,33 +601,33 @@ 7 ENVIRONMENT ************* -*LEDGER_FILE* The journal file path when not specified with '-f'. +*LEDGER_FILE* The journal file path when not specified with ‘-f’. - On unix computers, the default value is: '~/.hledger.journal'. + On unix computers, the default value is: ‘~/.hledger.journal’. - A more typical value is something like '~/finance/YYYY.journal', -where '~/finance' is a version-controlled finance directory and YYYY is -the current year. Or, '~/finance/current.journal', where + A more typical value is something like ‘~/finance/YYYY.journal’, +where ‘~/finance’ is a version-controlled finance directory and YYYY is +the current year. Or, ‘~/finance/current.journal’, where current.journal is a symbolic link to YYYY.journal. The usual way to set this permanently is to add a command to one of -your shell's startup files (eg '~/.profile'): +your shell’s startup files (eg ‘~/.profile’): export LEDGER_FILE=~/finance/current.journal` On some Mac computers, there is a more thorough way to set environment variables, that will also affect applications started from the GUI (eg, Emacs started from a dock icon): In -'~/.MacOSX/environment.plist', add an entry like: +‘~/.MacOSX/environment.plist’, add an entry like: { "LEDGER_FILE" : "~/finance/current.journal" } - For this to take effect you might need to 'killall Dock', or reboot. + For this to take effect you might need to ‘killall Dock’, or reboot. On Windows computers, the default value is probably -'C:\Users\YOURNAME\.hledger.journal'. You can change this by running a +‘C:\Users\YOURNAME\.hledger.journal’. You can change this by running a command like this in a powershell window (let us know if you need to be an Administrator, and if this persists across a reboot): @@ -637,10 +642,10 @@ 8 FILES ******* -Reads data from one or more files in hledger journal, timeclock, -timedot, or CSV format specified with '-f', or '$LEDGER_FILE', or -'$HOME/.hledger.journal' (on windows, perhaps -'C:/Users/USER/.hledger.journal'). +Reads data from one or more files in journal, timeclock, timedot, or CSV +format. The default file is ‘.hledger.journal’ in your home directory; +this can be overridden with one or more ‘-f FILE’ options, or the +‘LEDGER_FILE’ environment variable.  File: hledger-web.info, Node: BUGS, Prev: FILES, Up: Top @@ -648,10 +653,7 @@ 9 BUGS ****** -The need to precede options with '--' when invoked from hledger is -awkward. - - '-f-' doesn't work (hledger-web can't read from stdin). +‘-f-’ doesn’t work (hledger-web can’t read from stdin). Query arguments and some hledger options are ignored. @@ -661,27 +663,27 @@  Tag Table: -Node: Top223 -Node: OPTIONS2433 -Ref: #options2538 -Node: PERMISSIONS9937 -Ref: #permissions10076 -Node: EDITING UPLOADING DOWNLOADING11288 -Ref: #editing-uploading-downloading11469 -Node: RELOADING12303 -Ref: #reloading12437 -Node: JSON API12870 -Ref: #json-api12985 -Node: DEBUG OUTPUT18475 -Ref: #debug-output18600 -Node: Debug output18627 -Ref: #debug-output-118728 -Node: ENVIRONMENT19145 -Ref: #environment19265 -Node: FILES20576 -Ref: #files20676 -Node: BUGS20889 -Ref: #bugs20967 +Node: Top225 +Node: OPTIONS2724 +Ref: #options2829 +Node: PERMISSIONS10623 +Ref: #permissions10762 +Node: EDITING UPLOADING DOWNLOADING12020 +Ref: #editing-uploading-downloading12201 +Node: RELOADING13043 +Ref: #reloading13177 +Node: JSON API13610 +Ref: #json-api13725 +Node: DEBUG OUTPUT19257 +Ref: #debug-output19382 +Node: Debug output19409 +Ref: #debug-output-119510 +Node: ENVIRONMENT19935 +Ref: #environment20055 +Node: FILES21404 +Ref: #files21504 +Node: BUGS21764 +Ref: #bugs21842  End Tag Table diff --git a/hledger-web.txt b/hledger-web.txt --- a/hledger-web.txt +++ b/hledger-web.txt @@ -4,36 +4,41 @@ NAME - hledger-web is a web interface (WUI) for the hledger accounting tool. - This manual is for hledger-web 1.28. + hledger-web - robust, friendly plain text accounting (Web version) SYNOPSIS - hledger-web [OPTIONS] # run temporarily & browse - hledger-web --serve [OPTIONS] # run without stopping - hledger-web --serve-api [OPTIONS] # run JSON server only + hledger-web [OPTIONS] # run temporarily & browse + hledger-web --serve [OPTIONS] # run without stopping + hledger-web --serve-api [OPTIONS] # run JSON server only + hledger web -- [OPTIONS] [QUERYARGS] # start from hledger DESCRIPTION - hledger is a reliable, cross-platform set of programs for tracking - money, time, or any other commodity, using double-entry accounting and - a simple, editable file format. hledger is inspired by and largely - compatible with ledger(1). + This manual is for hledger's web interface, version 1.29. See also the + hledger manual for common concepts and file formats. - hledger-web is a simple web application for browsing and adding trans- - actions. It provides a more user-friendly UI than the hledger CLI or - hledger-ui TUI, showing more at once (accounts, the current account + hledger is a robust, user-friendly, cross-platform set of programs for + tracking money, time, or any other commodity, using double-entry + accounting and a simple, editable file format. hledger is inspired by + and largely compatible with ledger(1), and largely interconvertible + with beancount(1). + + hledger-web is a simple web application for browsing and adding trans- + actions. It provides a more user-friendly UI than the hledger CLI or + hledger-ui TUI, showing more at once (accounts, the current account register, balance charts) and allowing history-aware data entry, inter- active searching, and bookmarking. - hledger-web also lets you share a journal with multiple users, or even - the public web. There is no access control, so if you need that you - should put it behind a suitable web proxy. As a small protection - against data loss when running an unprotected instance, it writes a + hledger-web also lets you share a journal with multiple users, or even + the public web. There is no access control, so if you need that you + should put it behind a suitable web proxy. As a small protection + against data loss when running an unprotected instance, it writes a numbered backup of the main journal file (only) on every edit. - Like hledger, it reads data from one or more files in hledger journal, - timeclock, timedot, or CSV format specified with -f, or $LEDGER_FILE, - or $HOME/.hledger.journal (on windows, perhaps - C:/Users/USER/.hledger.journal). For more about this see hledger(1). + Like hledger, it reads data from one or more files in journal, time- + clock, timedot, or CSV format. The default file is .hledger.journal in + your home directory; this can be overridden with one or more -f FILE + options, or the LEDGER_FILE environment variable. For more about this + see hledger(1). hledger-web can be run in three modes: @@ -77,9 +82,9 @@ operating system can provide this type of socket. --base-url=URL - set the base url (default: http://IPADDR:PORT). You would - change this when sharing over the network, or integrating within - a larger website. + set the base url (default: http://IPADDR:PORT). Note: affects + url generation but not route parsing. Can be useful if running + behind a reverse web proxy that does path rewriting. --file-url=URL set the static files url (default: BASEURL/static). hledger-web @@ -320,7 +325,7 @@ Normally whenever a file is changed in this way, hledger-web saves a numbered backup (assuming file permissions allow it, the disk is not - full, etc.) hledger-web is not aware of version control systems, cur- + full, etc.) hledger-web is not aware of version control systems, cur- rently; if you use one, you'll have to arrange to commit the changes yourself (eg with a cron job or a file watcher like entr). @@ -401,7 +406,7 @@ Most of the JSON corresponds to hledger's data types; for details of what the fields mean, see the Hledger.Data.Json haddock docs and click on the various data types, eg Transaction. And for a higher level - understanding, see the journal manual. + understanding, see the journal docs. In some cases there is outer JSON corresponding to a "Report" type. To understand that, go to the Hledger.Web.Handler.MiscR haddock and look @@ -564,15 +569,12 @@ load/help/path.html. FILES - Reads data from one or more files in hledger journal, timeclock, time- - dot, or CSV format specified with -f, or $LEDGER_FILE, or - $HOME/.hledger.journal (on windows, perhaps - C:/Users/USER/.hledger.journal). + Reads data from one or more files in journal, timeclock, timedot, or + CSV format. The default file is .hledger.journal in your home direc- + tory; this can be overridden with one or more -f FILE options, or the + LEDGER_FILE environment variable. BUGS - The need to precede options with -- when invoked from hledger is awk- - ward. - -f- doesn't work (hledger-web can't read from stdin). Query arguments and some hledger options are ignored. @@ -584,16 +586,20 @@ REPORTING BUGS - Report bugs at http://bugs.hledger.org (or on the #hledger IRC channel - or hledger mail list) + Report bugs at http://bugs.hledger.org (or on the #hledger chat or + hledger mail list) AUTHORS - Simon Michael and contributors + Simon Michael and contributors. + See http://hledger.org/CREDITS.html COPYRIGHT - Copyright (C) 2007-2020 Simon Michael. + Copyright 2007-2023 Simon Michael and contributors. + + +LICENSE Released under GNU GPL v3 or later. @@ -602,4 +608,4 @@ -hledger-web-1.28 December 2022 HLEDGER-WEB(1) +hledger-web-1.29 March 2023 HLEDGER-WEB(1) diff --git a/templates/add-form.hamlet b/templates/add-form.hamlet --- a/templates/add-form.hamlet +++ b/templates/add-form.hamlet @@ -19,6 +19,17 @@ jQuery('input[name=description]').typeahead({ highlight: true }, { source: descriptionsSuggester.ttAdapter() }); jQuery('input[name=account]').typeahead({ highlight: true }, { source: accountsSuggester.ttAdapter() }); }); + + const utf8textdecoder = new TextDecoder(); + function decodeBase64EncodedText(b64) { + const unb64 = window.atob(b64); + const arr = new Uint8Array(unb64.length); + for (let i = 0; i < arr.length; i++) { + arr[i] = unb64.charCodeAt(i); + } + return utf8textdecoder.decode(arr); + } + ^{extra}