Sublet Agent

Sublet is a platform that enables domain owners to monetize their domains by leasing subdomains to developers and businesses. This allows for the utilization of unused domains, turning them into revenue-generating assets.

https://blog.june07.com/sublet/

Table of Contents

• Overview
• Features
• Quick Start
• Getting Started
  • Prerequisites
  • Installation
  • Configuration
  • Running the Application
• Usage
• Contributing
• License

Overview

Sublet provides a streamlined process for domain owners to lease subdomains, offering developers and businesses access to desirable domain names that might otherwise be unavailable. This fosters a collaborative environment where domain resources are efficiently utilized.

Features

• Domain Monetization: Earn revenue by leasing subdomains of your unused or underutilized domains.
• Developer Access: Developers can acquire subdomains on premium domains, enhancing their project's credibility.
• Automated Management: Simplifies the process of subdomain leasing with automated tools and configurations.

Quick Start

1. Create a free account

Creating a Sublet account is simple and the onboarding process to get paid (via Stripe) is streamlined.

Once you've created your account you can grab your API key to run the agent.

2. Run the Agent

NOTE: This is under the assumption that you use Cloudflare for you domains DNS which I know is a rather broad assumption (other providers are planned... would love help, PRs welcome!)

Setup a .env file:

You can do this with the setup tool...

  docker run --rm -it -v $(pwd):/usr/src/app/config ghcr.io/june07/sublet setup.js

or manually...

     SUBLET_API_KEY=sublet-apikey-aef160a3-459f-4315-bc45-0e55d849ccc4 # Sublet API key should start with 'sublet-apikey-'
     SUBLET_API_URL=https://sublet-api.june07.com
     CLOUDFLARE_EMAIL=your-cloudflare-email # This data is never sent to the server
     CLOUDFLARE_API_TOKEN=your-cloudflare-api-token # This data is never sent to the server

Then run the docker container:

docker run -v $(pwd)/sublet-config.js:/usr/src/app/config.js --env-file .env.sublet ghcr.io/june07/sublet

3. Profit!

That is literally all you need to do to get going with monetizing your domains.

Getting Started (development)

Follow these instructions to set up and run the Sublet application on your local machine.

Prerequisites

Ensure you have the following installed:

• Node.js
• Docker
• Docker Compose

Installation

1. Clone the Repository:

   git clone https://github.com/june07/sublet.git

2. Navigate to the Project Directory:

   cd sublet

3. Install Dependencies:

   npm install

Configuration

1. Environment Variables:

   • Duplicate the .env.example file and rename it to .env:

     cp .env.example .env

   • Open the .env file and configure the necessary environment variables as per your setup.

2. Docker Configuration:

   • The project includes docker-compose.yml for production and docker-compose.dev.yml for development environments. Choose the appropriate configuration based on your needs.

Running the Application

Using Docker:

• Development Environment:

  docker-compose -f docker-compose.dev.yml up

• Production Environment:

  docker-compose up

Without Docker:

1. Start the Application:

   npm start

2. For Development (with nodemon for automatic restarts):

   npm run dev

Usage

Once the application is running:

• Access the Dashboard: Navigate to http://localhost:PORT (replace PORT with the configured port) to access the Sublet dashboard.
• API Endpoints: Refer to the API documentation (if available) for information on interacting with the Sublet API.

Contributing

We welcome contributions to enhance Sublet. To contribute:

1. Fork the Repository.

2. Create a New Branch:

   git checkout -b feature/YourFeatureName

3. Make Your Changes.

4. Commit Your Changes:

   git commit -m 'Add some feature'

5. Push to the Branch:

   git push origin feature/YourFeatureName

6. Open a Pull Request.

License

This project is licensed under the MIT License.