README.md

Loggl

The self-hostable LogSnag alternative.
Learn more »

Website - Issue - Bug report

Loggl

Loggl is an self-hostable product analytics product. Automate the collection of every event on your website or app, with no need to send data to 3rd parties.

Development

Setup

1. Clone the repo into a public GitHub repository (or fork https://github.com/MarconLP/loggl/fork). If you plan to distribute the code, make sure to comply with our LICENSE.md.

   git clone https://github.com/MarconLP/loggl.git

2. Go to the project folder

   cd loggl

3. Install packages with yarn

   npm i

4. Set up your .env file

   • Duplicate .env.example to .env

   • Use openssl rand -base64 32 to generate a key and add it under NEXTAUTH_SECRET in the .env file.

   • Fill in the other variables

     Configure DATABASE_URL

     1. Open Railway and click "Start a New Project", and select Provision "MySQL".
     2. Select the MySQL App and copy the DATABASE_URL into the .env.

     Obtaining the Github API Credentials

     1. Open Github Developer Settings.
     2. Next, go to OAuth Apps from the side pane. Then click the "New OAuth App" button. Make sure to set Authorization callback URL to <Loggl URL>/api/auth/callback/github replacing Loggl URL with the URI at which your application runs.
     3. Copy the Client ID as GITHUB_ID into the .env.
     4. Next, click "Generate a new client secret" and copy the Client secret as GITHUB_SECRET into the .env.

     Obtaining the Firebase Credentials

     1. TODO: ADD Firebase documentation

5. Run (in development mode)

   npm run dev

Deployment

Vercel

License

Distributed under the Sustainable Use License. See LICENSE.md for more information.