In the past few days, I've seen a number of people having trouble getting Lemmy set up on their own servers. That motivated me to create Lemmy-Easy-Deploy, a dead-simple solution to deploying Lemmy using Docker Compose under the hood.

To accommodate people new to Docker or self hosting, I've made it as simple as I possibly could. Edit the config file to specify your domain, then run the script. That's it! No manual configuration is needed. Your self hosted Lemmy instance will be up and running in about a minute or less. Everything is taken care of for you. Random passwords are created for Lemmy's microservices, and HTTPS is handled automatically by Caddy.

Updates are automatic too! Run the script again to detect and deploy updates to Lemmy automatically.

If you are an advanced user, plenty of config options are available. You can set this to compile Lemmy from source if you want, which is useful for trying out Release Candidate versions. You can also specify a Cloudflare API token, and if you do, HTTPS certificates will use the DNS challenge instead. This is helpful for Cloudflare proxy users, who can have issues with HTTPS certificates sometimes.

Try it out and let me know what you think!

https://github.com/ubergeek77/Lemmy-Easy-Deploy

top 50 comments

sorted by: hot top controversial new old
[–] 17 points 3 years ago

As someone who spent hours figuring out how to deploy through Ansible, how dare you /s But seriously thank you for putting in the work to make creating an instance more attainable for people.

  • source
  • [–] 10 points 3 years ago (1 child)

    Literally been thinking about this so thank you beautiful brained individual. Would you mind if I shouted this in the YSK group?

  • source
  • hideshow 2 child comments
  • [–] 7 points 3 years ago

    Been pounding my head against the desk for the last TWO DAYS trying to get everything to work. Then you came along and solved all of my problems and it only took me 10 minutes to set up (mostly due to waiting on DNS to flush!)

    THANK YOU SO MUCH for creating this, and PLEASE continue to maintain! I will gib coffees if need be along the way!!

  • source
  • [–] 7 points 3 years ago (2 children)

    Really awesome work. We need more Lemmy servers!

  • source
  • hideshow 3 child comments
  • load more comments (1 reply)
    [–] 5 points 3 years ago

    You kind Sir/Lady/Gentleperson are making the fediverse a better place with this help. Thanks a bunch, gonna definitely ease my attempts at eventually self-hosting!

  • source
  • [–] 5 points 3 years ago (1 child)

    The check $LEMMY_HOSTNAME == http* will give a false positive if (for whatever reason) the domain name starts with http

  • source
  • hideshow 2 child comments
  • [–] 4 points 3 years ago (1 child)

    I'm relatively competent installing server software, but the Lemmy instructions completely flummoxed me. Their docker instructions just don't work.

    I ended up using the ansible docker scripts and filling out the blanks because I'm unfamiliar with ansible.

    If this is as good as it sounds, you're doing everyone a massive favour.

  • source
  • hideshow 1 child comment
  • load more comments (1 reply)
    [+] 3 points 3 years ago* (last edited 2 years ago) (1 child)
  • [–] 3 points 3 years ago (1 child)

    Nice! Looks like it even has update checker as well. Is there any reason why pictrs is not included in the update checker and hardcoded to version 0.3.1?

  • source
  • hideshow 2 child comments
  • [–] [S] 4 points 3 years ago* (1 child)

    The Lemmy maintainers themselves seem to lock it at 0.3.1, and I wanted to maintain parity with their deployment. I know pictrs is up to at least 0.3.3, and has a release candidate for 0.4, but upstream Lemmy uses 0.3.1 for whatever reason, so that's why I lock it there.

    It's excluded from the update checker because I don't have a stable way to check what version upstream is using. The Lemmy update checker just checks to see what the latest tag on LemmyNet/lemmy is. I could try and pull the latest Gitea tag for pictrs, but since upstream Lemmy isn't using the latest version, that's not really an option as something might break.

    I considered trying to parse their docker-compose.yml file to see what version they use, but they seem to be restructuring their docker folder right now. The folder in main is completely different from the one tagged 0.17.4. If I assume a certain directory path for that file for every version after this, but they move it, my script will break. Sadly, until their Docker deployment files seem like they're going unchanged for a good few versions, I'll have to do it manually for now.

  • source
  • parent
  • hideshow 2 child comments
  • [–] 3 points 3 years ago

    Will try this tomorrow. Tried them all. Nothing seems to work! I have been at it the whole week trying.

  • source
  • [–] 3 points 3 years ago (1 child)

    Looks great my dude.
    If you expanded out the environment variables a ton, making it more customizable, (with default values in place of couse) this could appeal to a huge range of people.

  • source
  • hideshow 2 child comments
  • [–] [S] 5 points 3 years ago

    Can you explain? I provide an interface for everything available in lemmy.hjson, so I am not sure what else I would add.

    I will note though, this is primarily intended for beginners. More advanced users would probably prefer to manage this on their own with Docker Compose, and those people will be very well versed in messing with the environment variables and all that.

    If there are variables you want to pass in, you can simply edit docker-compose.yml.template to import an env_file, that way you can pass anything you want into the container.

  • source
  • parent
  • [–] 3 points 3 years ago (1 child)

    I just made a post about having issues with getting a fully functional instance so I think I'm gonna give this a try.

  • source
  • hideshow 2 child comments
  • [–] [S] 4 points 3 years ago

    I hope it works out for you!

    Quick note: For email, pretty much every VPS provider out there blocks port 25, which is needed for emails to send. They do this to prevent spam emails from being sent en-masse from their servers. This is likely why your Ansible installation is not sending emails.

    Since it's uncommon for servers to support email, this script disables it by default. If your provider supports port 25 (or you get approved to use it, some VPS providers allow you to request access), check config.env and set USE_EMAIL to true. This will set up everything you need for email.

    I haven't been able to test email, so let me know how it works if you do! This doesn't do any of the DNS verification some email provders require, so your emails might be sent to spam. Lemmy doesn't really have documentation about how to set this up properly. If someone makes guidelines for this, I can update my project to do that automatically as well.

  • source
  • parent
  • [–] 3 points 3 years ago (1 child)

    I will definitely try this out. I already have my domain and SSL certificate. This will work on linode right?

  • source
  • hideshow 2 child comments
  • [–] [S] 3 points 3 years ago (22 children)

    It will work on pretty much anything that has a public IP and a domain pointing to that IP. The only thing that won't work "out of the box" for most users is email, as most VPS providers block port 25. If you've requested access to port 25 and have been approved to use it, you can edit config.env to turn on the email service.

    As for your SSL certificate, unfortunately this does not support importing your own certificate. It's made for beginners, after all :p

    But there should be no problems with Caddy simply requesting a new one for you!

  • source
  • parent
  • hideshow 22 child comments
  • load more comments (22 replies)
  • [–] 3 points 3 years ago

    Wow, I'll definitely look into this, thanks! Even if I don't use it, it still may be useful just reading through it.

  • source
  • [–] 2 points 3 years ago* (last edited 3 years ago)

    This was the only tool that I was able to get running. I recommend it to anyone curious about running their own instance. I tried both the official Ansible and Docker instructions, and neither worked.

  • source
  • [–] 2 points 3 years ago

    This was absolutely amazing. I was having some trouble with the build process using the docker compose from Lemmy itself, but this just instantly worked. Thank you!

  • source
  • [–] 2 points 3 years ago*

    I used this and the developer is very helpful. Works great. Helped me even upgrade to 0.18.0.

  • source
  • [–] 2 points 3 years ago

    After trying to do it with docker or ansible manually for hours and failing, this was soo helpful. So thank you.

  • source
  • [–] 2 points 3 years ago

    Works great on Linode!!

  • source
  • [–] 2 points 3 years ago* (last edited 3 years ago) (5 children)

    Looks really good. I did it pretty much the same way, myself - but if I were looking to start again, I would definitely use this.

    Edit: Ran it on a fresh AWS Ubuntu instance and it worked perfectly fine.

  • source
  • hideshow 5 child comments
  • load more comments (5 replies)
    [–] 2 points 3 years ago

    Thanks, this looks really nice. Bookmarked :)

  • source
  • [–] 2 points 3 years ago

    Thanks for the helpful tool! Posting this from my new single-user Lemmy instance. I ended up tweaking the compose template a bit to remove Caddy since I already have it running on this VPS for other services. Wasn't too bad to just take the Caddyfile information and add it to my own existing framework.

  • source
  • [–] 1 point 3 years ago

    You are helping the whole community! Thank you, I will give a try to it, since I'm quite new in self-hosted platform!

  • source
  • load more comments
    view more: next ›