itssimple / journal-limpet

Journal storage / API for Elite: Dangerous
https://journal-limpet.com
GNU Lesser General Public License v3.0
10 stars 0 forks source link

Share guide how to deploy selfhosted instance of journal-limpet #30

Open norohind opened 2 years ago

norohind commented 2 years ago

I thought I will be able to figure out what needed for an instance by myself just by running it and viewing backtrace, solving problems and running it again until no backtraces shows up, and I successfully ran redis and created Journal-Limpet.environment that contains valid json ({}) but now I stuck with database, I don't know how and where to specify credentials for DB. I'm fully unfamiliar with c# language and entire dotnet ecosystem and couldn't solve the problem just by viewing source code. I would appreciate if you share a manual for deploying the project.

itssimple commented 2 years ago

First off: Even if the project is open source, the database (including schema), minio and redis backend is not publicly available.

This is the format of the Journal-Limpet.environment file

{
        "EliteDangerous": {
                "ClientId": "",
                "ClientSecret": ""
        },
        "Database": {
                "ConnectionString": "",
                "HangfireConnection": ""
        },
        "Minio": {
                "ConnectionString": "",
                "AccessKey": "",
                "SecretKey": ""
        },
        "Patreon": {
                "GoalApiUrl": ""
        },
        "Hangfire": {
                "AuthKey": ""
        },
        "SendGrid": {
                "ApiKey": ""
        },
        "Discord": {
                "ErrorWebhook": ""
        },
        "Twitter": {
                "ConsumerKey": "",
                "ConsumerSecret": "",
                "AccessToken": "",
                "AccessSecret": ""
        },
        "ErrorMail": "",
        "CanonnRD": {
                "QueryString": "",
                "JournalEndpoint": ""
        }
}

And I intend to not give out any documentation on how to host this separately, as I'm already hosting the service on https://journal-limpet.com

Is there any reason you want to host this yourself?

itssimple commented 2 years ago

Fixing a few code issues, and adding DB schema.

As for the other parts of deploying it, I'll see if I can put something together later, as it currently involves GitHub Actions for building and Octopus Deploy for deploying new versions.

But it should work by running dotnet run in the Journal-Limpet-folder (project, not root)

norohind commented 2 years ago

Thanks for schema.

Is there any reason you want to host this yourself?

I wanted use it in order to collect and examine journals from small group of about 5 people (with their agreement, of course) in research purposes.

itssimple commented 2 years ago

I've just committed some more data into the repo that should help you setup the service.

Not an entire documentation on it, but should be a bit easier at least.