222
submitted 2 years ago* (last edited 2 years ago) by ubergeek77@lemmy.ubergeek77.chat to c/selfhosted@lemmy.world

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
[-] IrrationalNumber@lemmy.world 19 points 2 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.

[-] andobando@lemmy.world 2 points 2 years ago

What was difficult about ansible? The 4 step instructions worked perfectly for me.

load more comments (1 replies)
[-] ruud@lemmy.world 10 points 2 years ago

Really awesome work. We need more Lemmy servers!

[-] lemmy@lemmy.captainapathetic.cfd 3 points 2 years ago

seriously, distributing the load helps a LOT. Though if you can't spin up your own instance one thing you can do is try and host pictures externally, in !youshouldknow!youshouldknow@lemmy.world a post mentioned how to do it for images in comments since by default it has you upload if you don't manually put in ![image](link)

load more comments (1 replies)
load more comments (1 replies)
[-] asimplefriedegg@yiffit.net 10 points 2 years ago

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

[-] ubergeek77@lemmy.ubergeek77.chat 9 points 2 years ago

Thank you very much for the kind words!

Please be my guest! It would make me happy to know this was helping people join Lemmy!

[-] Eddie@lucitt.social 7 points 2 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!!

[-] master@lem.serkozh.me 6 points 2 years ago

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

[-] ubergeek77@lemmy.ubergeek77.chat 4 points 2 years ago

Thanks! Fix pushed.

[-] untilyouarrived@lemmy.gtfo.social 6 points 2 years ago

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.

load more comments (1 replies)
[-] Marxine@lemmy.world 5 points 2 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!

[-] JCreazy@midwest.social 4 points 2 years ago

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

[-] ubergeek77@lemmy.ubergeek77.chat 3 points 2 years ago

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!

load more comments (22 replies)
[-] Illecors@lemmy.cafe 4 points 2 years ago

I appreciate the effort, but for software as experimental as Lemmy I would argue making things 1-click "simple" will inevitably lead to people breaking their instances in the future, when some migration will be required.

I would strongly suggest people figure things on their own.

[-] redcalcium@c.calciumlabs.com 3 points 2 years ago

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?

[-] ubergeek77@lemmy.ubergeek77.chat 5 points 2 years ago* (last edited 2 years ago)

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.

[-] redcalcium@c.calciumlabs.com 3 points 2 years ago* (last edited 2 years ago)

I see, looks like it's a correct decision to me. Let the Lemmy developers worry about which version of pictrs to use themselves.

[-] MigratingtoLemmy@lemmy.world 3 points 2 years ago

Thanks, this looks really nice. Bookmarked :)

[-] Stijn@lemmy.antemeridiem.xyz 3 points 2 years ago

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

[-] Manifish_Destiny@kbin.social 3 points 2 years ago

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.

[-] ubergeek77@lemmy.ubergeek77.chat 5 points 2 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.

[-] CaptainApathetic@lemmy.world 3 points 2 years ago

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

[-] ubergeek77@lemmy.ubergeek77.chat 4 points 2 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.

[-] ipkpjersi@lemmy.one 3 points 2 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.

[-] Thief@lemmy.myserv.one 2 points 1 year ago* (last edited 1 year ago)

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

[-] mfn@mfn.pub 2 points 1 year ago

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

[-] lemmy@lemmy.quad442.com 2 points 2 years ago

Works great on Linode!!

[-] IrrationalNumber@lemmy.world 2 points 2 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.

[-] falcon15500@lemmy.nine-hells.net 2 points 2 years ago* (last edited 2 years ago)

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.

load more comments (5 replies)
[-] delcake@lemmy.songsforno.one 2 points 2 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.

[-] lemmy@acqrs.co.uk 2 points 2 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!

load more comments
view more: next ›
this post was submitted on 18 Jun 2023
222 points (100.0% liked)

Selfhosted

40670 readers
348 users here now

A place to share alternatives to popular online services that can be self-hosted without giving up privacy or locking you into a service you don't control.

Rules:

  1. Be civil: we're here to support and learn from one another. Insults won't be tolerated. Flame wars are frowned upon.

  2. No spam posting.

  3. Posts have to be centered around self-hosting. There are other communities for discussing hardware or home computing. If it's not obvious why your post topic revolves around selfhosting, please include details to make it clear.

  4. Don't duplicate the full text of your blog or github here. Just post the link for folks to click.

  5. Submission headline should match the article title (don’t cherry-pick information from the title to fit your agenda).

  6. No trolling.

Resources:

Any issues on the community? Report it using the report flag.

Questions? DM the mods!

founded 2 years ago
MODERATORS