๐Ÿ’พ Archived View for bbs.geminispace.org โ€บ s โ€บ GmCapsule โ€บ 1767 captured on 2023-11-04 at 13:59:22. Gemini links have been rewritten to link to archived content

View Raw

More Information

โฌ…๏ธ Previous capture (2023-09-28)

โžก๏ธ Next capture (2023-11-14)

๐Ÿšง View Differences

-=-=-=-=-=-=-

Now that Bubble supports Titan I'm interested in trying it out on my capsule; however, the existing information on how to set it up server side isn't obvious to me. Anyone have some basic example on how to use Titan on your capsule? I'm using gmcapsule

#python

Posted in: s/GmCapsule

๐Ÿ€ gritty

2023-06-09 ยท 5 months ago ยท ๐Ÿ‘ jsreed5, Addison

7 Comments โ†“

๐Ÿš€ jsreed5

I'd be interested to learn more about this too. My capsule runs JetForce and does not support Titan natively.

๐Ÿ€ gritty

yeah, I think just a basic "hello world" example implementation would be quite useful, say in like Python.

๐Ÿš€ skyjake

I can put together a GmCapsule Titan hello world example for you.

Are you primarily interested in the CGI interface, or doing a Python extension module? The latter is more flexible/powerful since you're using Python, but the CGI one is pretty standard and easy, done via environment variables and stdin.

2023-06-10 ยท 5 months ago

๐Ÿš€ skyjake

These examples assume gmcapsuled running on localhost.

Here is a simple CGI Python script that we'll use:

#!/usr/bin/python3
import os
import sys

titan_data = sys.stdin.read()

print("20 text/gemini\r")
print("Client cert hashes:", os.getenv('REMOTE_IDENT'))
print("Titan token:", os.getenv('TITAN_TOKEN'))
print("You uploaded %d bytes." % len(titan_data))

Method 1: CGI entry point in server config

Place the above script file anywhere you'd like, say "scripts/hello.py", and add this to the server config:

[cgi.hello]
protocol = titan
path = /hello-world
command = /usr/bin/python3 scripts/hello.py

(paths are relative to where you start gmcapsuled)

Then open "titan://localhost/hello-world" in the client to start an upload.

Method 2: CGI bin_root

The advantage of setting the `bin_root` is that you can add and remove scripts in your CGI directory without restarting the server.

Normally executables inside the bin_root are assumed to be Gemini CGI scripts. To make them use Titan, append ",titan" to the executable name. So, let's create a bin_root directory called "./cgi-bin", and your script should be named:

./cgi-bin/localhost/hello-world,titan

Don't forget to set the file as executable.

The bin_root is configured in the server config:

[cgi]
bin_root = ./cgi-bin

You can then open "titan://localhost/hello-world" in the client to start an upload.

Methods 1 and 2 are mutually exclusive, you can choose which one works best for you.

Method 3: Extension module

It's actually quite simple to create a simple Titan upload handler via a Python extension module. Add a custom modules directory in the server config:

[server]
modules = ./mymod

Create this Python source file as "./mymod/50_hello.py":

def titan_upload_handler(req):
    response = 'Client cert hash: ' + req.identity.fp_cert
    response += '\nYou uploaded %d bytes.\n' % len(req.content)
    return response


def init(capsule):
    """Extension module initialization."""    
    capsule.add('/titan-hello', 
                titan_upload_handler, 
                protocol='titan')

Open "titan://localhost/titan-hello" to start the upload.

๐Ÿ€ gritty

@skyjake thank you! exactly what I was looking for, appreciate the detailed response. I was also wondering about extensions so that helps as well

๐Ÿš€ skyjake

No problem! I've been planning to write documentation like this and make it available on my capsule.

One more thing to note: the current version of GmCapsule requires that Titan uploads use a client certificate, i.e., no anonymous uploads are allowed. I need to add a config parameter for this.

โ€” /s/GmCapsule-Issues/3

๐Ÿ€ gritty

@skyjake ah yes, I was wondering about the client cert prompts, makes sense now