Skip to content

Latest commit

 

History

History
91 lines (62 loc) · 2.77 KB

README.md

File metadata and controls

91 lines (62 loc) · 2.77 KB
Raw

Gisty.link

Gisty.link is a platform that allows users to easily share content or gists through a simple link. Users can submit content via a form, which is securely stored in OpenStack Swift, and retrieve it later using a unique URL. The platform is built using Vapor, Swift, and Tailwind CSS, with a GitHub-inspired dark theme.

Features

  • Submit content using a simple form.
  • Content is stored in OpenStack Swift with a unique hashed identifier.
  • Retrieve content by entering the generated link.
  • GitHub-inspired dark theme using Tailwind CSS.
  • Responsive design with a dynamic layout.

Set up environment variables

Ensure you have the following environment variables set for connecting to OpenStack Swift.

This project uses application credentials, and will require you to setup specific OpenStack application credentials before starting. This is done so that your account credentials are never used to the operations of this applications and can be revoked or rotated without creating an issue with the account itself. Application credential information is loaded into the runtime via environment variables. More on application credentials can be found here.

export KEYSTONE_AUTH_URL="your-keystone-auth-url"
export KEYSTONE_APP_ID="your-username"
export KEYSTONE_APP_SECRET="your-password"
export SWIFT_CONTAINER_NAME="gisty"

Building the container

Running the build locally is simple.

docker build . -t $USER/gisty

Images are also provided in this repo.

Starting the service

docker run -e KEYSTONE_APP_ID=XXX -e KEYSTONE_AUTH_URL=XXX -e KEYSTONE_APP_SECRET=XXX --network=host $USER/gisty

Accessing the service

Open your browser and navigate to http://localhost:8080 to access Gisty.link.

Usage

Access and usage is simple.

Submit Content

  1. Go to the home page (/).
  2. Fill out the form with your content.
  3. Click "Submit". You will be redirected to a unique link where your content is accessible.

Retrieve Content

  • Use the unique link provided after submission to access your content.
  • RAW content can be accessed by simply accessing the RAW URL.

API Interactions

API interactions are simple with two main methods, POST and GET.

POST Content

curl -D - -X POST https://gisty.link/create -H "Content-Type: application/x-www-form-urlencoded" -d "textInput=thingames"

The output will return the new item location

HTTP/1.1 303 See Other
Server: nginx/1.22.1
Date: Sun, 08 Sep 2024 19:43:10 GMT
Content-Length: 0
Connection: keep-alive
location: /71b6eada156eeafee3feb6c464faf0edc8aa5636

GET Content

curl https://gisty.link/71b6eada156eeafee3feb6c464faf0edc8aa5636/raw