summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTimotej Lazar <timotej.lazar@araneo.si>2023-11-12 22:34:30 +0100
committerTimotej Lazar <timotej.lazar@araneo.si>2023-11-13 09:01:36 +0100
commit4523cf8f8d379f448e6f06dfb0de7838db29d5d5 (patch)
treed375cfa7f8ff758e907aeccbbc27858e21b83a39
parentbc39829c52bb53e3c73e81e65771a23918c0b3c1 (diff)
Add README
-rw-r--r--README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3e354fb
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+# margfools
+
+Python script to replace [MargTools](https://businessconnect.margis.si/output/#orodja). Can be used to sign documents with [GovernmentConnect](https://margis.si/produkti/government-connect/).
+
+## Usage
+
+Create the configuration file `~/.margfools` with the paths to your TLS private key and certificate in PEM format:
+
+ [https://gcsign.example.com/BCSign/]
+ user-key = <path/to/key.pem>
+ user-cert = <path/to/cert.pem>
+
+Section name is the percent-decoded value of `baseURL` in
+
+ bc-digsign://sign?accessToken=…&baseUrl=https%3a%2f%2fgcsign.example.com%2fBCSign%2f&…'
+
+You can set `margfools` as the default program for `bc-digsign` URLs by copying the `margfools.desktop` file to `~/.local/share/applications/` and running
+
+ xdg-mime default margfools.desktop x-scheme-handler/bc-digsign
+
+or by setting the default application in your browser.