caracal 0.2.2

Nostr client for Gemini
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95

![logo](https://gitlab.com/cipres/caracal/-/raw/master/media/img/caracal.png)

A simple [Nostr](https://nostr.how) client with a [gemini](https://geminiprotocol.net) interface.

The beauty of the Nostr protocol combined with the simplicity of Gemini.

- Remote signer (bunker)
- Encrypted private messages (NIP-17)
- Polls
- Hashtags browser
- [Nsite](https://nsite.run) browser
- Note drafts with Titan
- Long-form notes rendering (markdown => gemtext)
- Supports file uploads to nostr storage servers via the [Titan](https://communitywiki.org/wiki/Titan) protocol (implements [NIP-96](https://github.com/nostr-protocol/nips/blob/master/96.md))

*caracal* is written in Rust and uses the [rust-nostr](https://rust-nostr.org) SDK.

![screenshot-feed](https://gitlab.com/cipres/caracal/-/raw/master/media/screenshots/caracal-feed.png)

## Install
### Cargo

```sh
cargo install caracal
```

### GitLab

You can download the latest binary release for Linux
[here](https://gitlab.com/cipres/caracal/-/releases/continuous-master/downloads/caracal).

```sh
curl -L -o ~/.local/bin/caracal https://gitlab.com/cipres/caracal/-/releases/continuous-master/downloads/caracal
chmod +x ~/.local/bin/caracal
```

### AppImage

There's also an AppImage that bundles both *caracal* and *Lagrange* (when you run it,
you will automatically land on the homepage). You can download
it [here](https://gitlab.com/cipres/caracal/-/releases/continuous-master/downloads/caracal-x86_64.AppImage).

```sh
curl -L -o caracal-x86_64.AppImage https://gitlab.com/cipres/caracal/-/releases/continuous-master/downloads/caracal-x86_64.AppImage
chmod +x ./caracal-x86_64.AppImage
./caracal-x86_64.AppImage
```

## Usage

To use *caracal*, you'll need to use a Gemini browser like
[Lagrange](https://gmi.skyjake.fi/lagrange/).

Start *caracal*, open Lagrange and go to [gemini://localhost](gemini://localhost).
You should see a page telling you that you need to use a X509 Gemini certificate.

From Lagrange, create an identity by selecting
*New identity for domain* in the identities controller menu (top-right corner).
Lagrange will then always use this certificate to access caracal.

*caracal* maps your Gemini identity to your Nostr identity, therefore you can
have multiple Nostr identities by creating different Gemini certificates and
switching between them.

### Remote signer (Nostr Connect)

If you want to use a remote signer (bunker), create an identity in Lagrange
(*New identity for domain*), click on *More*, and set the *Organization*
field's value to **nostr**. After creating the identity, activate it and you will
be prompted for the *Nostr Bunker URI*. Copy-paste your bunker URI and send it.
You should now be connected to the remote signer.

### Web content

To show embedded images in nostr notes, you just need to run a web-to-gemini
proxy like [levior](https://gitlab.com/cipres/levior) and
[configure](https://gitlab.com/cipres/levior#lagrange) Lagrange to use the proxy.

### Drafts

*caracal* supports writing and editing note drafts using the
[titan](https://communitywiki.org/wiki/Titan) protocol. Click on *New draft*
in the homepage and you should get a Titan dialog window from Lagrange. Be sure
to select the correct identity.

Once you've uploaded your draft, you can edit it by just pressing *Ctrl+e*.

You can attach files to your note by clicking on *Upload file* in the note.
Files are uploaded to a server that supports *NIP-96* file uploads.

Just click on *Post note* when you're ready to send it.

## Donations

Monero: 46CAwqF4zwjL3Pe1oxtr2AGbmzLFY4rp6eAGkiDbAfYnYCAx8C47dex2XGb6VqXDUoYEZmemLzKxT1wkjFU6ebk23DensvR