about summary refs log tree commit diff stats
Commit message (Expand)AuthorAgeFilesLines
...
* Merge pull request #1717 from MarcoPolo-PasTonMolo/fix/chat-with-self-duplica...Michael Vetter2022-06-112-1/+13
|\
| * Fix duplicate messages in chat with oneself.MarcoPolo-PasTonMolo2022-05-312-1/+13
* | Fix typo in omemo commandMichael Vetter2022-06-051-1/+1
* | Merge pull request #1718 from profanity-im/feat/omemo-displ-qrcodeMichael Vetter2022-05-317-5/+33
|\ \
| * | Use our omemo sid/fingerprint in qr codeMichael Vetter2022-05-317-5/+33
|/ /
* | Merge pull request #1568 from profanity-im/feature/1320-omemo-qrcodeMichael Vetter2022-05-3114-10/+115
|\ \
| * | build: dont define HAVE_QRENCODE at all in case not presentMichael Vetter2022-05-311-2/+1
| * | build: set HAVE_QRENCODE only onceMichael Vetter2022-05-301-3/+1
| * | Make qrencode optional and add to CIMichael Vetter2022-05-307-12/+22
| * | Add command help for omemo qrcodeMichael Vetter2022-05-302-2/+6
| * | Reverse QR code colors and add paddingswirl2022-05-302-8/+19
| * | implement working OMEMO QR codeswirl2022-05-302-8/+19
| * | Add basic qrcode functionsMichael Vetter2022-05-308-1/+73
|/ /
* | Merge pull request #1714 from MarcoPolo-PasTonMolo/feature/avatar-setMichael Vetter2022-05-3016-7/+220
|\ \
| * | Add pixbuf building to CIMichael Vetter2022-05-307-7/+14
| * | Final touches for `/avatar set`Michael Vetter2022-05-275-10/+8
| * | Add checks for whether gdk-pixbuf exists before using avatar setMarcoPolo-PasTonMolo2022-05-266-3/+31
| * | Add `/avatar set` command to publish avatarMarcoPolo-PasTonMolo2022-05-268-1/+181
* | | Merge pull request #1712 from MarcoPolo-PasTonMolo/fix/1347Michael Vetter2022-05-292-7/+45
|\ \ \ | |_|/ |/| |
| * | Make muc config update after form submitMarcoPolo-PasTonMolo2022-05-272-7/+45
| |/
* | Fix description of moodMichael Vetter2022-05-271-1/+1
* | Merge pull request #1716 from MarcoPolo-PasTonMolo/fix/ignore-nick-changeMichael Vetter2022-05-261-0/+2
|\ \
| * | Respect silent nick change in mucsMarcoPolo-PasTonMolo2022-05-261-0/+2
|/ /
* | Merge pull request #1715 from MarcoPolo-PasTonMolo/fix/ox-discover-segfaultMichael Vetter2022-05-261-5/+8
|\ \ | |/ |/|
| * Fix segfault on `/ox discover`MarcoPolo-PasTonMolo2022-05-261-5/+8
|/
* Merge pull request #1711 from MarcoPolo-PasTonMolo/fix/roomname-updateMichael Vetter2022-05-231-0/+8
|\
| * Fix room name not updating.MarcoPolo-PasTonMolo2022-05-181-0/+8
|/
* Merge pull request #1708 from wurstsalat3000/patch-1Michael Vetter2022-05-091-1/+1
|\
| * DOAP: Use correct namespace for xmlns:schemaDaniel Brötzmann2022-05-091-1/+1
|/
* Update copyright yearMichael Vetter2022-05-0948-50/+50
* Merge pull request #1707 from profanity-im/change-redact-defaultsMichael Vetter2022-05-092-7/+7
|\
| * Log encrypted messages by default to chatlogMichael Vetter2022-05-092-7/+7
|/
* Merge pull request #1705 from profanity-im/feat/ox-improvements2Michael Vetter2022-05-0910-27/+91
|\
| * ox: remove /ox sendfile because its actually not implementedMichael Vetter2022-05-052-11/+1
| * ox: show ox preferencesMichael Vetter2022-05-055-0/+35
| * ox: Add /ox log commandMichael Vetter2022-05-056-1/+41
| * ox: only process proper messagesMichael Vetter2022-05-041-12/+11
| * ox: prefix function _openpgp_signcrypt with ox_Michael Vetter2022-05-041-3/+3
|/
* ox: have metadata node openMichael Vetter2022-05-041-0/+6
* ox: return upon invalid fingerprintMichael Vetter2022-05-041-1/+2
* Merge pull request #1703 from profanity-im/feat/ox-improvements1Michael Vetter2022-05-047-112/+236
|\
| * ox: fix mistakes in p_ox_gpg_decrypt()Michael Vetter2022-05-041-1/+3
| * Improve ox command helpMichael Vetter2022-05-041-2/+3
| * ox: print message when `/ox end` is run but not startedMichael Vetter2022-05-041-4/+8
| * ox: print more error messages to UIMichael Vetter2022-05-031-2/+6
| * ox: dont require marginal trust levelMichael Vetter2022-05-031-0/+5
| * Bugfix OX rpad generationStefan Kropp2022-05-031-4/+6
| * ox_key_is_usable - Logging and owner trust checkStefan Kropp2022-05-031-0/+6
| * ox: use glib date function in _gettimestamp and fix memleakMichael Vetter2022-05-031-12/+10
| * ox: Use connection_create_stanza_id() instead of xmpp_uuid_gen()Michael Vetter2022-05-031-4/+4
generated by cgit-pink 1.4.1-2-gfad0 (git 2.36.2.497.gbbea4dcf42) at 2025-01-09 20:06:36 +0000
{.Like This}}` in the template. ### Proxying Though getwtxt will run perfectly fine facing the internet directly, it does not understand virtual hosts, nor does it use TLS (yet). You'll probably want to proxy it behind `Caddy` or `nginx` for this reason. `Caddy` is ludicrously easy to set up, and automatically handles `TLS` certificates. Here's the config: ```caddyfile twtxt.example.com proxy / example.com:9001 ``` If you're using `nginx`, here's a skeleton config to get you started. Don't forget to change the 5 instances of `twtxt.example.com` to the (sub)domain you'll be using to access the registry, generate SSL/TLS certificates using `letsencrypt`, and change the port in `proxy_pass` to whichever port you specified when modifying the configuration file. Currently, it's set to the default port `9001` ```nginx server { server_name twtxt.example.com; listen [::]:443 ssl http2; listen 0.0.0.0:443 ssl http2; ssl_certificate /etc/letsencrypt/live/twtxt.example.com/fullchain.pem; ssl_certificate_key /etc/letsencrypt/live/twtxt.example.com/privkey.pem; include /etc/letsencrypt/options-ssl-nginx.conf; ssl_dhparam /etc/letsencrypt/ssl-dhparams.pem; location / { proxy_set_header Host $host; proxy_set_header X-Forwarded-For $remote_addr; proxy_pass http://127.0.0.1:9001; } } server { if ($host = twtxt.example.com) { return 301 https://$host$request_uri; } listen 80; server_name twtxt.example.com; return 404; } ``` ### Starting getwtxt Once you have everything configured to your needs, use `systemctl` to enable it to run on system boot, then start the service. ``` $ sudo systemctl enable getwtxt ... $ sudo systemctl start getwtxt ``` ## Using the Registry The following examples will all apply to using `curl` from a `Linux`, `BSD`, or `macOS` terminal. All timestamps are in `RFC3339` format, per the twtxt registry specification. Additionally, all queries support the `?page=N` parameter, where `N` is a positive integer, that will retrieve page `N` of results in groups of twenty. The example API calls can also be found on the landing page of any getwtxt instance, assuming the admin has not customized the landing page. * [twtxt.tilde.institute](https://twtxt.tilde.institute) ### Adding a User Both nickname and URL are required ``` $ curl -X POST 'https://twtxt.example.com/api/plain/users?url=https://mysite.ext/twtxt.txt&nickname=FooJr' 200 OK ``` ### Get All Tweets ``` $ curl 'https://twtxt.example.com/api/plain/tweets' foo_barrington https://foo.bar.ext/twtxt.txt 2019-03-01T09:31:02.000Z Hey! It's my first status! ... ... ``` ### Query Tweets by Keyword ``` $ curl 'https://twtxt.example.com/api/plain/tweets?q=getwtxt' foo_barrington https://example3.com/twtxt.txt 2019-04-30T06:00:09.000Z I just installed getwtxt! ``` ### Get All Users Timestamp reflects when the user was added to the registry. ``` $ curl 'https://twtxt.example.com/api/plain/users' foo_barrington https://foo.barrington.ext/twtxt.txt 2017-01-01T09:17:02.000Z foo_barrington_jr https://example.com/twtxt.txt 2019-03-01T09:31:02.000Z ... ... ``` ### Query Users Can use either keyword or URL. ``` $ curl 'https://twtxt.example.com/api/plain/users?url=https://example.com/twtxt.txt' foo https://example.com/twtxt.txt 2019-05-09T08:42:23.000Z $ curl 'https://twtxt.example.com/api/plain/users?q=foo' foo https://example.com/twtxt.txt 2019-05-09T08:42:23.000Z foobar https://example2.com/twtxt.txt 2019-03-14T19:23:00.000Z foo_barrington https://example3.com/twtxt.txt 2019-05-01T15:59:39.000Z ``` ### Get all tweets with mentions Mentions are placed within a status using the format `@<nickname http://url/twtxt.txt>` ``` $ curl 'https://twtxt.tilde.institute/api/plain/mentions' foo https://example.com/twtxt.txt 2019-02-28T11:06:44.000Z @<foo_barrington https://example3.com/twtxt.txt> Hey!! Are you still working on that project? bar https://mxmmplm.com/twtxt.txt 2019-02-27T11:06:44.000Z @<foobar https://example2.com/twtxt.txt> How's your day going, bud? foo_barrington https://example3.com/twtxt.txt 2019-02-26T11:06:44.000Z @<foo https://example.com/twtxt.txt> Did you eat my lunch? ``` ### Query tweets by mention URL ``` $ curl 'https://twtxt.tilde.institute/api/plain/mentions?url=https://foobarrington.co.uk/twtxt.txt' foo https://example.com/twtxt.txt 2019-02-26T11:06:44.000Z @<foo_barrington https://foobarrington.co.uk/twtxt.txt> Hey!! Are you still working on that project?e ``` ### Get all Tags ``` $ curl 'https://twtxt.example.com/api/plain/tags' foo https://example.com/twtxt.txt 2019-03-01T09:33:04.000Z No, seriously, I need #help foo https://example.com/twtxt.txt 2019-03-01T09:32:12.000Z Seriously, I love #programming! foo https://example.com/twtxt.txt 2019-03-01T09:31:02.000Z I love #programming! ``` ### Query by Tag ``` $ curl 'https://twtxt.example.com/api/plain/tags/programming' foo https://example.com/twtxt.txt 2019-03-01T09:31:02.000Z I love #programming! ``` ## Benchmarks * [bombardier](https://github.com/codesenberg/bombardier) ``` $ bombardier -c 100 -n 200000 http://localhost:9001/api/plain/tweets Bombarding http://localhost:9001/api/plain/tweets with 200000 request(s) using 100 connection(s) 200000 / 200000 [=============================================================] 100.00% 19961/s 10s Done! Statistics Avg Stdev Max Reqs/sec 20006.58 2408.55 26054.73 Latency 5.00ms 3.58ms 62.99ms HTTP codes: 1xx - 0, 2xx - 200000, 3xx - 0, 4xx - 0, 5xx - 0 others - 0 Throughput: 39.27MB/s ``` ## Other Documentation In addition to what is provided here, additional information, particularly regarding the configuration file, may be found by running getwtxt with the `-m` or `--manual` flags. You will likely want to pipe the output to `less` as it is quite long. ``` $ ./getwtxt -m | less $ ./getwtxt --manual | less ``` If you need to remove getwtxt from your system, navigate to the source directory you acquired using `git` during the installation process and run the appropriate `make` hook: ``` $ sudo make uninstall ``` ## Notes twtxt Information: [`twtxt.readthedocs.io`](https://twtxt.readthedocs.io) Interested in twtxt but don't have your own server? [https://github.com/LuRsT/twtxt_on_heroku](https://github.com/LuRsT/twtxt_on_heroku) twtxt Client Repo: [`github.com/buckket/twtxt`](https://github.com/buckket/twtxt) Registry Specification: [`twtxt.readthedocs.io/en/latest/user/registry.html`](https://twtxt.readthedocs.io/en/latest/user/registry.html) Special thanks to [`github.com/kognise/water.css`](https://github.com/kognise/water.css) for open-sourcing a pleasant, easy-to-use, importable stylesheet ### Contributing All contributions are greatly appreciated! Please open an issue, submit a pull request, anything. If you're interested in contributing, take a look at the github project page for getwtxt, linked below, where I've listed various items I'm working on or plan to work on in the very near future. It'll give you some inspiration for pull requests to submit. If you have an idea for a new feature or come across a bug, submitting a new issue will be greatly appreciated as well. * [getwtxt Development: the road to 1.0.0](https://github.com/getwtxt/getwtxt/projects/1) * [open an issue](https://github.com/getwtxt/getwtxt/issues)
generated by cgit-pink 1.4.1-2-gfad0 (git 2.36.2.497.gbbea4dcf42) at 2025-01-09 20:06:36 +0000