Skip to content
Snippets Groups Projects
Commit e06f894b authored by Axel Dürkop's avatar Axel Dürkop
Browse files

improve headlines

parent db1997b4
No related branches found
No related tags found
No related merge requests found
...@@ -16,6 +16,8 @@ For more background, see the initial [discussion](https://github.com/hackmdio/co ...@@ -16,6 +16,8 @@ For more background, see the initial [discussion](https://github.com/hackmdio/co
- `wget` (install via `apt install wget` or `brew install wget` on Mac) - `wget` (install via `apt install wget` or `brew install wget` on Mac)
- `jq` (install via `apt install jq` or `brew install jq` on Mac) - `jq` (install via `apt install jq` or `brew install jq` on Mac)
### Instructions
Clone the repository. Clone the repository.
$ git clone https://github.com/hedgedoc/cli $ git clone https://github.com/hedgedoc/cli
...@@ -48,12 +50,12 @@ Test your configuration by creating a new note with FREELY access and no login r ...@@ -48,12 +50,12 @@ Test your configuration by creating a new note with FREELY access and no login r
Check for the document in the browser by concatenating the Check for the document in the browser by concatenating the
address of your server and the `<note_id>`. address of your server and the `<note_id>`.
## Documentation ## Configuration and usage
It's not necessary to authenticate against the server in order to make use of `hedgedoc-cli`. But without authentication you won't have access to the non-FREELY documents and everything that's accessible behind the login.
### Variants of authentication ### Variants of authentication
It's not necessary to authenticate against the server in order to make use of `hedgedoc-cli`. But without authentication you won't have access to the non-FREELY documents and everything that's accessible behind the login.
#### Authenticate with cookie #### Authenticate with cookie
Authentication with a cookie is so far the only way if you login with GitLab and the like. Use browser extensions like [Get cookies.txt](https://chrome.google.com/webstore/detail/get-cookiestxt/bgaddhkoddajcdgocldbbfleckgcbcid) to store the cookie in `key.conf`. Authentication with a cookie is so far the only way if you login with GitLab and the like. Use browser extensions like [Get cookies.txt](https://chrome.google.com/webstore/detail/get-cookiestxt/bgaddhkoddajcdgocldbbfleckgcbcid) to store the cookie in `key.conf`.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment