Lukittu

Lukittu (a Finnish word meaning "locked") is a modern software licensing service that provides robust APIs to enhance the security and trackability of your applications. It introduces a licensing layer to protect proprietary software from unauthorized sharing and misuse, offering benefits such as enhanced security, usage analytics, easy integration, and flexible licensing. Lukittu is particularly suitable for applications like game scripts and add-ons running on client servers, including platforms like Minecraft, FiveM, and Roblox.

Features

Flexible License Management – Support for various licensing models
Customer Management – Organize and manage licensees efficiently
Product Release Versioning – Track and manage different software versions
Advanced Watermarking – Protect Java applications with unique identifiers
Detailed Analytics & Logging – Monitor usage and detect potential abuse
Team Collaboration – Work with your team seamlessly
Comprehensive API – Easily integrate Lukittu with your applications

Hosting Options

Lukittu is available in two hosting options:

Free Tier – Essential features for small projects at no cost
Pro Tier (€2.90/month) – Enhanced features and higher limits for commercial projects

For detailed pricing and feature comparisons, visit our website.

Important

While self-hosting Lukittu is possible, it is not recommended for most users. Lukittu is designed as a SaaS platform with proper security measures and ongoing maintenance. If you choose to self-host, be aware that by default anyone can register and use the platform unless you implement custom modifications. These modifications may complicate receiving updates from upstream. For more information about self-hosting requirements and limitations, please refer to our self-hosting documentation.

Local Development

Lukittu uses a pnpm workspace monorepo structure with the following packages:

apps/web: The core Next.js application
apps/bot: Lukittu's Discord bot
packages/shared: Shared code and utilities

To get started with the project locally, follow the steps below:

1. Setup Environment Variables

Lukittu requires three different .env files for each part of the application on local development:

Web Application: Copy apps/web/.env.example to apps/web/.env
Bot Application: Copy apps/bot/.env.example to apps/bot/.env
Shared Package: Copy packages/shared/.env.example to packages/shared/.env

Each .env file contains configuration specific to its respective application component. Fill in all required values in each file before proceeding.

Note: The DATABASE_URL must be consistent across all environment files that require it.

2. Install Node.js, Docker, and pnpm

Ensure the following tools are installed on your system:

Node.js v20+ (Download from nodejs.org)
Docker (Install from docker.com)
pnpm v9.11.0+ (Package manager for Node.js, install via pnpm.io)

3. Install Dependencies

Once the environment is set up, install dependencies for all workspaces:

pnpm install

4. Start Local Databases

To start the local databases (PostgreSQL & Redis), use Docker Compose:

docker compose -f docker-compose-local.yml up

This command will spin up the containers for both PostgreSQL and Redis.

5. Run Database Migrations

Run the necessary database migrations to set up your database schema:

pnpm --filter @lukittu/shared migrate

6. Start the Application

After the migrations are complete, start the local application:

pnpm dev

This will run the dev script for all workspaces simultaneously.

To run commands for a specific workspace, use the --filter flag:

# Run Next.js development server only
pnpm --filter lukittu-web dev

# Generate Prisma client
pnpm --filter @lukittu/shared generate

7. Access the Application

Navigate to http://localhost:3000 in your browser, and you should have everything running!

Troubleshooting

Ensure Docker is running before starting the databases.
Make sure to have all environment variables filled correctly in the .env file.
If you encounter dependency issues, try running pnpm install --force to refresh dependencies.

Community & Support

Join our community Discord server to get help, share ideas, and connect with other developers: https://discord.lukittu.com/

How to Support the Project

The best way to support Lukittu is to give it a star on GitHub – it’s free and helps us grow the community!

Documentation

For comprehensive documentation on how to use Lukittu, visit: https://docs.lukittu.com/introduction. The documentation source can be found in its own repository here.

Contributing

We welcome contributions from the community! Whether it’s bug fixes, feature improvements, or documentation updates, your help is appreciated.

How to Contribute:

Open an issue – Discuss proposed changes before starting work
Fork the repository – Create your own copy to work on
Create a feature branch – Organize your changes
Make your changes – Implement improvements or fixes
Submit a pull request – Share your work with the community

Discussing changes before implementation ensures efficient collaboration and valuable contributions.

Contributors

License

Lukittu is licensed under the GNU Affero General Public License v3.0 (AGPL-3.0).

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!