summaryrefslogtreecommitdiff
path: root/doc/hsc.md
Commit message (Collapse)AuthorAgeFilesLines
* doc/hsc.md: Add clarification about KeystoreIdsIan Jackson2025-11-241-1/+2
| | | | | Applies @Dizet's suggestion from https://gitlab.torproject.org/tpo/core/arti/-/merge_requests/3485#note_3291709
* doc/hsc.md: Use toml block for config exampleGabriela Moldovan2025-11-241-1/+1
|
* doc/hsc.md: Remove note about invalid keystoresGabriela Moldovan2025-11-241-7/+0
| | | | | | | | | | | I don't think we need to tell users a C Tor keystore cannot have more than one client entry for the same onion service, because they already know that: C Tor doesn't allow it, so if they are migrating an existing C Tor configuration, it will likely be valid. And if not, the error message will inform them what went wrong. So I am removing this section in the interest in keeping this guide short and sweet and straight to the point.
* doc/hsc.md: Warn against running tor/arti during the migrationGabriela Moldovan2025-11-241-0/+6
| | | | This is analogous to the warning from `doc/hss.md`.
* doc/hsc.md: s/ctor-keystore-id/ctor-clientGabriela Moldovan2025-11-241-3/+3
| | | | | Otherwise users might think it's idiomatic/necessary to add the `-id` suffix to their keystore identifiers.
* doc/hsc.md: Rephrase section about --batchGabriela Moldovan2025-11-241-5/+5
| | | | | This makes the language more consistent with the `hss ctor-migrate` docs.
* doc/hsc.md: Add missing text before example invocationGabriela Moldovan2025-11-241-0/+2
|
* doc/hsc.md: Say keystore identifiers must be uniqueGabriela Moldovan2025-11-241-0/+3
|
* doc/hsc.md: Add comments to the config exampleGabriela Moldovan2025-11-241-0/+12
| | | | | This should help clarify what each of those options means. It's also consistent with the analogous example from `doc/hss.md`.
* doc/hsc.md: Remove config from usage exampleGabriela Moldovan2025-11-241-1/+1
| | | | There's no need to pass a config file when using `-o`.
* doc/hsc.md: Rewrite usage section for better readabilityGabriela Moldovan2025-11-241-5/+3
|
* doc/hsc.md: Move warning higher up in the documentGabriela Moldovan2025-11-241-12/+12
|
* doc/hsc.md: Add a more user-friendly introGabriela Moldovan2025-11-241-2/+5
| | | | | | This a bit more user-friendly, because not all users will know what "a registered C Tor keystore is". It's also more consistent with the style from the `hss ctor-migrate` docs (for migrating service keys).
* doc/hsc.md: Use gerund in headingsGabriela Moldovan2025-11-241-1/+1
| | | | For consistency with the other headings.
* Add `hsc key ctor-migrate` subcommandhjrgrn2025-11-241-3/+57
|
* doc/hsc.md: Apply style fixes from @jnewsome.Gabriela Moldovan2025-09-161-4/+4
|
* doc/hsc.md: Fix hard to parse sentence.Gabriela Moldovan2025-09-121-4/+2
| | | | | | | | This rephrases a sentence I found difficult to grok. Found as while grepping for "the user" as part of #2138. Closes #2138
* doc/hsc.md: Mention that `--batch` suppresses the prompting.Gabriela Moldovan2025-09-031-0/+8
|
* arti: test: Refactor arti integration testhjrgrn2025-05-121-1/+0
| | | | | | | * arti: test: Restructure tests directory * arti: dep: Add assert_cmd dev-dependency * arti: test: Update README * doc: Fix hsc documentation
* Merge branch '1630-scrub-address-from-output' into 'main'gabi-2502025-03-191-9/+8
|\ | | | | | | | | | | | | hsc: remove onion-address flag in favour of stdin Closes #1630 See merge request tpo/core/arti!2861
| * doc: Improve hsc documentationhjrgrn2025-03-171-4/+4
| |
| * doc: Update hsc documentationhjrgrn2025-03-141-9/+8
| | | | | | | | | | * In hsc.rs has been removed `onion-address` flag in favour of getting the value required from stdin
* | arti: hsc-key-get: Print LF after discovery keyplaybahn2025-03-131-0/+1
|/ | | | | Did not print a newline after service discovery key. Looked bad. Prints newline now. Looks better.
* Deprecate --onion-name; introduce --onion-addressdisha2025-03-121-4/+4
|
* arti: Clarify what the client is supposed to do with the hsc key output.Gabriela Moldovan2024-09-191-0/+8
|
* arti: Document that "arti hsc" is experimental.Gabriela Moldovan2024-09-191-0/+3
|
* arti: Omit the optional --key-type argument from the docs.Gabriela Moldovan2024-09-191-1/+1
| | | | | | By default `--key-type` is set to `restricted-discovery` so it can omitted from these examples (omitting it makes the usage a bit clearer IMO).
* arti: Document the commands for key removal and rotation.Gabriela Moldovan2024-09-191-1/+41
|
* arti: Add hsc key subcommand, deprecate hsc get-key.Gabriela Moldovan2024-09-181-5/+5
| | | | | | | | | | I am deprecating the old `hsc get-key` subcommand in favor of the new `hsc key get` subcommand. This is because I plan to implement the rest of the key management functionality (key deletion, rotation, etc.) as subcommands of the `hsc key` command. The alternative would be to add a new distinct top-level `hsc rotate-key`, `hsc remove-key`, etc. subcommand alongside the existing `hsc get-key` command (which IMO is less nice than the alternative I'm proposing).
* Fix typosDimitris Apostolou2024-09-031-1/+1
|
* doc: Add arti hsc subcommand docs to doc/hsc.md.Gabriela Moldovan2024-08-051-0/+28
This also makes the `tests/testcases/hsc/hsc.md` test case a symlink to `doc/hsc.md`.