Spyke
selfhosted·Selfhostedbyubergeek77

Having trouble deploying Lemmy? Try my new script! Get up and running in minutes!

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

Having trouble deploying Lemmy? Try my new script! Get up and running in minutes!https://github.com/ubergeek77/Lemmy-Easy-DeployOpen linkView original on lemmy.ubergeek77.chat
lemmy.world

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.

20
andobandoreply
lemmy.world

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

2

I'm just a novice hobbyist (the only server I've put together was a homebridge server years ago) so the learning curve for this was relatively high putting together a VPS, setting up ssh, learning how to properly configure, and there were some errors when running the playbook I had to slowly figure out. Honestly though once it was all done, I thought "man, that was actually pretty easy" and I learned a lot so that was really cool

1
lemmy.world

Really awesome work. We need more Lemmy servers!

13

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[email protected] 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)

5
yiffit.net

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

11

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!

10

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

8

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!!

7

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.

7

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!

5
midwest.social

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

5
ubergeek77reply
lemmy.ubergeek77.chat

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!

3
JCreazyreply
midwest.social

I think I have successfully got the server running on my linode.

2
ubergeek77reply
lemmy.ubergeek77.chat

I'm glad to hear that! Thanks for letting me know, it's nice to hear people were able to use my script to get up and running :)

1
JCreazyreply
midwest.social

Once I got it up and running, I had to figure out how to get my domain to redirect to it. Now I just gave to figure out how to start federating with other instances.

1
ubergeek77reply
lemmy.ubergeek77.chat

If your instance is fully reachable from the public, all you have to do is search for the community you want to federate with in your search bar. For example, if you wanted to federate with and subscribe to this community, put this in your search bar, then hit search:

https://lemmy.world/c/selfhosted

Give it a few seconds, until you either see "No results" disappear, or until you see it show up as " - 0 subscribers" in the search results. This works for kbin communities too!

You might see some people say to search it like [email protected], but I have way more success with doing it with the actual links. After you've done that, you can click on Communities at the top of your instance's page, click the All tab, then start subscribing with some of them.

It will only start pulling "new" data though, you won't get days or week old posts like this. But, if there is something you want to see/comment on from your instance, you can put the direct link to any post, comment, or user into your instance's search bar, to make it "aware" of that post/comment/user. Then you can just interact like normal.

Welcome to the self-hosted Fediverse!

2
monnuireply
waveform.social

Wait, so pardon my noobism, but does this mean you need to federate with communities manually? Don't instances start out as already being federated with everything?

1

Yep. It's all manual. There are hundreds of Lemmy instances out there, new instances have no way of discovering any of them unless you tell it how.

Federation with a community only has to happen once. After it's connected, the instance will always receive new data and posts from that point forward. That is why the major public instances always have posts from a wide variety of instances.

But, only a single person needs to do the federation, it doesn't have to be done by an admin. After the connection is made with a community, content from that community will start showing up on "All" for that instance for everyone.

3

Hey there. Not that Lemmy has been updated, do you know how long until the script can pull the update?

Edit: I saw on GitHub you'll have to update the script.

1
b3nsn0wreply
pricefield.org

how well do those email servers work to begin with? i just flat out disabled the postfix relay on my instance and simply configured sendgrid, which works perfectly, no delays or spam folder issues (although i did have to disable a bunch of tracking bullshit). doing so with similar services has been my go-to card in freelance webdev, because getting other mail servers to trust you can be hard, so i'm interested in the experience people are having with those. (i'd much prefer to self-host email too, but providing a good experience is the primary goal)

1
ubergeek77reply
lemmy.ubergeek77.chat

I haven't actually used the embedded postfix server at all, I keep mine disabled. I only include it because it's "included" in the official Docker deployment files, and I try to keep this deployment as close to that as possible.

I'm considering adding support for an external email service, as you mentioned, but I have nearly zero experience in using managed email services, and I'm not sure if non-technical users would be able to navigate the configuration of things I can't do for them (i.e. on a web dashboard somewhere). And if I can't do it for them, it means more issues for me, so I hesitate to add support for it at all.

I'd love to hear your experience in setting up sendgrid and how easy that was. And the tracking stuff you mentioned as well.

2
b3nsn0wreply
pricefield.org

On the surface, setting up an external mail server is actually super easy. Pretty much every service supports SMTP, so all you need is to find your credentials (an endpoint, a username, and a password) and input that in your lemmy.hjson file, along with a sender address. There is a verification process with every email provider, you will usually have to set some DNS records to prove you own the domain you're trying to send from, but once you do these two things, emails will just start flying out.

The actual process tends to be a little more tedious though. Pretty much every mail provider wants to sell you on their specific super awesome API and only mentions SMTP as a footnote, for reasons that I can only parse as an attempted vendor lock-in. They also sometimes make the verification process difficult. SendGrid, for example, immediately redirects you to their "sender identities" which are more useful for their marketing automation tooling than they are for automated emails from a website, and you also have to dig a fair bit to find the SMTP credentials. (The endpoint is smtp.sendgrid.net, apikey on the username, and whatever your API key is for the password, you'll need to set one of those up.) They also have a number of different tracking things that you'll have to find and turn off in the UI (luckily all of them can be toggled in the same place), which would normally actually help you by providing you statistics about how many emails were opened and how many people clicked on links, but for the emails Lemmy sends, it's useless and I didn't want SendGrid to collect that data on my instance users, so I shut that off.

Initially, I wanted to use Amazon SES, but they have an even more tedious setup: you have to talk to an actual human to have them turn it on for you, otherwise you're stuck in sandbox mode and can only send email to verified receiver addresses. Their service works well though, I used it a lot in my freelancer days, and they do make it fairly straightforward to find the SMTP credentials, but the verification process can be slow.

I also remember using Mailgun for some project ages ago, it was pretty much the same deal as all the others: you have to pry the SMTP details out of their docs, but once you do and you verify your stuff, it works well.

Ultimately, I think the best you could do to help out users here is to provide them with documentation for a few of these services: exactly where to go, which buttons to click and whatnot. Or just stick to the embedded service for a bit, but the real issue there is the bounce rates from spammers. They made my instance send out like 60-70 verification emails for bogus addresses on gmail, yahoo, hotmail, and live.com on the first day I got federation working, and if you don't already have a good reputation -- which is what these third parties help you with -- then you can easily get yourself blacklisted, either internally or externally.

1
ubergeek77reply
lemmy.ubergeek77.chat

I see. Thanks a lot for this!

I really don't have the capacity to support a bunch of different email services, so it sounds like the best I can do right now is make the SMTP settings accessible without also running the postfix server. So if someone wants to run their own email somewhere else, they can configure it. But otherwise, I'll leave it to the user to figure out what happens after an email request leaves Lemmy.

Does that sound fair, and like something you would have used? Essentially just an interface in config.env that puts the right SMTP address/credentials in lemmy.hjson.

2
b3nsn0wreply
pricefield.org

yup, that sounds perfect

i can't track down a non vendor-specific guide right now but if you just expose the same settings in config.env that you'd have in the lemmy.hjson file that should be more than sufficient to get an external service going

1
netburnrreply
lemmy.world

Email is vital to lemmy working. Saying this works without mail config is just silly.

1
ubergeek77reply
lemmy.ubergeek77.chat

I'm not sure what you mean? Most people are just self hosting instances for themselves, where email isn't needed. My instance doesn't have an email service.

And as I explained, if email is something you want, I have an advanced option for this. It's not the default because there is not a public VPS host out there that lets you use port 25 without special approval.

2
netburnrreply
lemmy.world

Email config is needed for lost passwords. It's also needed for account verification, if you run without verification you could easily become a place for people to abuse other servers and get yourself defederated.

Many web hosts have poisoned mail IPs, so setting up with a smtp config to a well known site server is required if you want your emails to be delivered.

2

And that is why I don't advertise this as supporting email out of the box, and why it's an advanced option without any support from me. The embedded postfix server is part of the official Docker Compose deployment from upstream Lemmy, and it's part of the officially supported Ansible deployment too. Those deployment methods are what this is modeled after. That is as far as I go on email support. If upstream Lemmy started including some automatic AWS SNS configuration, I would adopt it, but they have not done so.

Everyone who has reported success to me so far are running single user instances for themselves. That is my target audience, and for that audience (and myself), email is not even close to being a hard requirement.

However, if you would like to improve this script by adding support for more robust and secure email systems, I would be happy if you submitted a PR to do just that :)

6
8565reply
lemmy.quad442.com

Don't lose your passwords and leave closed registration so only people you actually want on your instance are on it. You absolutely do not need email.

0
netburnrreply
lemmy.world

You can't have the checkbox for federation and private, the server will crash and tell you that in the lemmy log. Had that happen when I did thy to setup without email the first time.

2

Private and federation are mutually exclusive concepts. Private instances are ones that intentionally don’t federate - like a private company community that’s locked to their intranet. For self hosted Lemmy instances you just need to close registration. Then since no one can apply, the only use case for email becomes the Forgot Password button for if you forget your password and at that point you’re better served with a password manager.

3

"Private instance" and "disable registration" are not the same thing. There are separate options for both. It is possible to run a federated single-user instance with registrations disabled. That's how I run mine.

1

Weird. I used this script with no working email. How's it going from my private instance that is federated?

1

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

4
c.calciumlabs.com

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?

3

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.

5

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

3

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

3

Sorry, I don't have access to an unRaid system to test it with.

However, I know most NAS systems at least support CLI-style Docker and Docker Compose, so if you can manage to get Docker running, it might work? The script has some Docker detection if you're not sure.

However, I know Synology hogs use of port 80 and 443. I'm not sure if unRaid is the same way. If it is, this might not be the best solution for you. But, if you want to give it a shot, I do have some advanced options in my config that lets you change to different ports and turn off HTTPS (so you can run a proxy in front of it). I can't really help people who run it behind a webserver like this, but the template files in my repo can be freely modified, so you're welcome to hack at my script any way you like to get it working!

1

Did you figure out how to run this right from the docker portion of unraid? I'm about to get mine going and I'm probably just going to start a Ubuntu vm.

1

You can try changing the ports in docker-compose.yml.template. I just use Caddy in this because its HTTPS convenience is hard to beat!

2

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

3

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.

4

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.

3

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.

5
lemmy.world

So stupid question - how do you shut them down? Docker compose down or stop don't seem to work.

Also, as an intermediate (spoiled Unraid) user, if I'm behind nginx proxy manager with custom ports do I just change 80 and 443 in the lemmy docker-compose? I'm doing this in a Debian VM.

2

I'll add some better instructions for this to the readme.

You can do any Docker compose commands by changing to the ./live folder, then running:

docker compose -p lemmy-easy-deploy <command>

can be whatever Docker Compose supports, up,down,ps, etc.

I don't have config options for the ports, but you can just change them in docker-compose.yml.template to change what they're listening on. As long as yourdomain.com:80 is reachable from the public, it shouldn't matter what routing shenanigans are going on behind it.

2
lemmy.world

What adjustments I need to do to run this locally (in my LAN) just for testing?

2
ubergeek77reply
lemmy.ubergeek77.chat

I haven't tested a local only use case, but you can probably set these options in config.env

  • Set LEMMY_HOSTNAME to localhost
  • Set CADDY_DISABLE_TLS to true
  • Set TLS_ENABLED to false

This will disable any HTTPS certificate generation and only run Lemmy on port 80. I don't know if Caddy or Lemmy will act weird if the hostname is localhost, but this should work for you. Let me know if it doesn't.

1
ChaosADreply
lemmy.world

Sorry to bring more problems to you.

SOLVED: The problem was caused because I was using a | In the site name SETUP_SITE_NAME

for some reason the bash script is returning sed: -e expression #7, char 32: unknown option to `s' I 've looked online and found nothing that related to my problem. I suspect the problem starts in line 253 because the file lemmy.hjson is empty and the docker-compose.yml isn't created.

3
ubergeek77reply
lemmy.ubergeek77.chat

Good catch!

I will make a note in the example file about this. You can use special characters if you want, but you'll need to backslash escape them first. So in config.env, you probably could have done:

SETUP_SITE_NAME="Lemmy \| Server"
2
ChaosADreply
lemmy.world

hi! do you have some IM we could talk please? I am getting insane haha, trying to bring up a server for 4 days now lol I think your method is the closest to work but I am getting something wrong.

5
ChaosADreply
lemmy.world

OK! So here we go.

I already use Caddy on my server because of other services I have running so I was afraid it could conflict with the caddy container in the docker-compose you provide, so I disabled caddy service just for testing and afterwards I could try to figure how to make it work alongside my current configuration. But for some reason I can't get my domain to connect to the instance.

So I decided to try different and do not install the caddy container and use the one I have running natively. So I just coppied the Caddyfile content that is generated by the deploy.sh and replaced the env variable with my domain name (just to make sure it would work).

I changed the docker-compose.yml to this:

version: "3.9"
x-logging:
  &default-logging
  options:
    max-size: '500m'
  driver: json-file

services:

  lemmy:
    image: dessalines/lemmy:0.17.4
    environment:
      - RUST_LOG="warn,lemmy_server=info,lemmy_api=info,lemmy_api_common=info,lemmy_api_crud=info,lemmy_apub=info,lemmy_db_schema=info,lemmy_db_views=info,lemmy_db_views_actor=info,lemmy_db_views_moderator=info,lemmy_routes=info,lemmy_utils=info,lemmy_websocket=info"
    volumes:
      - ./lemmy.hjson:/config/config.hjson
    depends_on:
      - postgres
      - pictrs
    networks:
      - lemmyinternal
      - lemmybridge
    ports:
      - 8536:8536
    restart: always
    logging: *default-logging

  lemmy-ui:
    image: dessalines/lemmy-ui:0.17.4
    environment:
      - LEMMY_UI_LEMMY_INTERNAL_HOST=lemmy:8536
      - LEMMY_UI_LEMMY_EXTERNAL_HOST=localhost:1236
      - LEMMY_HTTPS=true
    depends_on:
      - lemmy
    networks:
      - lemmyinternal
    ports:
    #Always keep em guessing
      - 1236:1234
    restart: always
    logging: *default-logging

  pictrs:
    image: asonix/pictrs:0.3.1
    user: 991:991
    env_file:
      - ./pictrs.env
    volumes:
      - pictrs_data:/mnt
    networks:
      - lemmyinternal
      - lemmybridge
    restart: always
    logging: *default-logging

  postgres:
    image: postgres:15-alpine
    environment:
      - POSTGRES_USER=lemmy
      - POSTGRES_DB=lemmy
    env_file:
      - ./postgres.env
    volumes:
      - postgres_data:/var/lib/postgresql/data
    networks:
      - lemmyinternal
    ports:
      - 5432:5432
    restart: always
    logging: *default-logging

networks:
  lemmyexternalproxy:
  lemmybridge:
  lemmyinternal:
    driver: bridge
    internal: true

Placed all the .env in the same folder of the docker-compose.yml and placed the lemmy.hjson in this same folder too.

{
  setup: {
    admin_username: "lemmy"
    admin_password: "sjhdakjhsdjhasdkjashdjkahs"
    site_name: "Lemmy"
  }

  hostname: "lemmy.domain"
  bind: "0.0.0.0"
  port: 8536
  tls_enabled: true

  pictrs: {
    url: "http://pictrs:8080/"
    api_key: "dkslahlsdjhasjdçlajsçdaskj"
  }

  database: {
    user: "lemmy"
    password: "jahdskjhadjsappdsiadopisap"
    host: "postgres"
    port: 5432
    database: "lemmy"
    pool_size: 5
  }

}

runned the docker-compose up -d and everything went OK, no errors in the terminal. but still my domain don't connect.

I have disabled cloudflare proxy and cache but nothing helped :(

2

Sorry, combining this with an already-running webserver is not a use case I support for this easy deployment script. My script is intended for new deployments for people not already running servers.

The best thing you can do is change the ports in docker-compose.yml.template, and today I will make an update that gives you environment variables for them.

Unfortunately I do not have time to help you dig deeper into the issue, but hopefully these tips help you:

  • Change the ports in docker-compose.yml.template to something that won't conflict with your webserver. Take note of what port you used for 80
  • Edit config.env and set CADDY_DISABLE_TLS to true
  • Edit your own webserver config to point to this deployment via a reverse proxy. I'll leave it up to you to configure that. You are already using Caddy, so you can look at my Caddyfile for inspiration on how reverse proxies work.

Since you're using your own webserver, doing it this way will not automatically retrieve certificates for you. Hopefully you have a system in place for that already.

Good luck!

2

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.

2
Zachreply
bigfoot.ninja

Were you able to get AWS to open port 25 for smtp support?

1
lemmy.nine-hells.net

I didn't bother, as I was just testing. But you are right, port 25 outbound is blocked by default. They have a defined process for you to ask for it to be unblocked and you have to tell them what you are using it for and how you are preventing spam from being sent. In this case it might be enough to say that you aren't allowing port 25 inbound, so it can't be used as an open relay.

1
Zachreply
bigfoot.ninja

Yeah, I tried and failed. They denied it and told me to use SES lol.

Whatever haha

1

I am not 100% surprised they refuse to do it for new accounts. If you have an account that has been with them for a while, they most likely would open it.

Problem with SES is that you start sandboxed and can only deliver to specific email addresses - which obviously won't work here.

1

Yeah maybe, i've had my account for a few years but who knows.

If i decide do use email i'll just make an smtp mail server on my homelab

2

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!

2

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.

2
communick.news

A bit OT, but worth the shot: can anyone confirm whether instances deployed with this script can be found on Mastodon?

I have tried both the ansible script provided by the developers and I've adapted the docker-compose files to get things running on Docker Swarm. Everything seems to be working well, object storage, federation... except that I can not find any user or community from my instance if I search from Mastodon.

2

I saw a bug

I see this user who deployed using this script, I click the username link below his name which should lead to server.tld/u/username, but it leads to server.tld/users/username, maybe some kind of dbUser -> outside world configuration is broken?

Also the Bio is different on his local instance and the federated instance?

2

Thank you for this. One suggestion though, on the config prompt where it says to not use http or https, maybe suggest to DO use www.. I'm a potato and didn't include that and made caddy mad. It would be helpful for other potatoes.

2

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

2

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

2

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.

2
lemmy.world

Is this easier than the Ansible deployment? That was very straight forward if you’re running a system with apt.

1

I am biased, but I would say yes, it is. There is only one config file to manage in my project, whereas the Ansible config has three separate config files the user needs to copy and edit.

You also need* a different system with Ansible installed to actually run the playbook, since Ansible needs to connect to your server to run it. That is an extra installation step, on top of needing some way to ensure Ansible has the right SSH credentials to connect.

*you can tell Ansible to connect to localhost, but this is not supported and a beginner wouldn't know to do this.

There is nothing wrong with the playbook though! I just thought beginners might be a bit intimidated by it, and the dependency on apt is a bit of a bummer.

3

thanks, it looks good. The biggest plus it that it doesn’t rely on a Debian based system.

3

Threw an error:

Creating lemmy-easy-deploy_pictrs_1 ... 
Creating lemmy-easy-deploy_postgres_1 ... error

ERROR: for lemmy-easy-deploy_postgres_1  Cannot start service postgres: failed to create task for container: failed to create shim task: OCI runtime create failed: runc cr
Creating lemmy-easy-deploy_pictrs_1   ... error: permission denied: unknown
1
ubergeek77reply
lemmy.ubergeek77.chat

Does your user have permission to use Docker? You could try running the script as root and seeing if that helps?

Is there any other info about your system that you can provide? For example, are you using a non-standard OCI runtime, such as podman? I've added detection for podman-compose in the script, but I haven't tested it yet. If you're using something like that, you'll need to ensure all the permissions are set up correctly.

3
ubergeek77reply
lemmy.ubergeek77.chat

From a quick Google search, it looks like there may have been a bug in the Docker engine a few months ago that might cause this. If possible, please update your Docker engine.

If the issue still occurs, unfortunately this is a core Docker engine/Docker Compose issue, and outside of my ability to fix :(

3

Docker Compose is just a frontend script for Docker, it doesn't provide the engine. Is it possible you don't have Docker itself installed? I will add an additional check to my script to guide users into making sure Docker is installed.

Regardless of if you have Docker installed or not, if you are on Ubuntu, the Ubuntu version of Docker is usually several versions out of date. I recommend following this guide to help you uninstall everything Docker related from your system, then reinstalling the most stable and up to date version of Docker.

https://docs.docker.com/engine/install/ubuntu/

After doing this, reboot your server, then try again. Make sure you can run:

docker run hello-world

If that errors too, then unfortunately there is not a lot I can do to help you. But hopefully reinstalling from the official Docker sources works for you.

If you aren't on Ubuntu, you can get specific instructions for different distributions directly on this page:

https://docs.docker.com/engine/install/

For the guide you're following, you should be sure to follow the "Uninstall old versions" part, then proceed with the rest of the commands on the page.

EDIT: I've updated the script to add some additional checks and messages that may help avoid this for future users!

1

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

1
lemmy.world

Hi @[email protected]

I must be doing something wrong here because unlike many others I can't seem to get this working! Please can you offer some advice?

I have amended the config.env file to change the HOSTNAME, SITE NAME and ADMIN USER but left everything else the same.

I then ran ./deploy.sh and everything seems to have worked because it presented me with the admin login credentials and basic instructions to shutdown and start the instance. I tried simply typing the IP address of the docker container in to a browser but that didn't work and TBH I didn't expect it to. I then typed the URL into the browser and I'm getting a "ERR_TOO_MANY_REDIRECTS" error message. I read through the trouble shooting on your Github but the only reference to too many redirects mentions a Cloudflare API token, I'm not using Cloudflare nut I am using nginx proxy manager to point my URL to the docker container.

I hope some of this makes sense.

1
ubergeek77reply
lemmy.ubergeek77.chat

Hey there, please note that running behind a reverse proxy is not supported. You can do it if you want, but you are kinda on your own, sorry.

If it helps, you will probably need to disable Caddy's TLS in the config, and you will need to make sure that the request reaches Caddy via the correct host. You can't reverse proxy directly to port 80 over an IP, it needs to think it's coming from an actual domain.

You can also check out my advanced configuration page to learn how to override the Caddyfile template and roll your own config that is more compatible for your use case.

Good luck!

2
SonyJunkiereply
lemmy.world

Thank you so much for replying.

I think this is above my skill level, but I will have a read through your advanced configuration page and see if I can understand it.

Thanks again, but I think I'm going to need more than luck!! LOL

1

You're welcome!

If you're not already, I recommend trying to host this on a cloud VPS service, such as Vultr, Linode, or DigitalOcean. This would give you a reliable, always online Lemmy instance, which means you won't miss any federation data. Even a cheap $5 VPS instance would be enough to get you started, though a $10 would give you more breathing room.

If you're hosting at home, it's generally not a good idea to do that, especially for an application like Lemmy. Most consumer grade network equipment at home might not be equipped to deal with the unrelenting 24/7 flood of data coming in due to federation. And if your power or internet ever goes out, you will be missing any comments, posts, or votes that were sent out during your downtime.

1

Thank you again. Yeah, I'm trying this from home as opposed to a vps. It's more as a learning exercise than a serious instance.

I'm still going to try and getting it working behind my reverse proxy, like I say, as a learning experience.

1

Marius Hosting published a good guide this week that I used on my nas without an issue (via docker compose).

1
lemmy.world

Hey @[email protected], I'm trying this on an Aarm64 instance and the script says it only works on v0.17.4. Is there a plan to update to 0.18?

EDIT: the script fails for 0.17.4 here:

=> ERROR [lemmy builder 6/7] RUN cargo build --release 1183.5s

Build timer continues but CPU usage drops off. Any ideas where I've gone wrong?

1
ubergeek77reply
lemmy.ubergeek77.chat

Before this week, I would have told you no. But I have big plans for the 0.18.1 update.

The Lemmy team has completely broken ARM support with seemingly no plan to support it again. They switched to a base Docker image that only supports x86_64. This is why your build fails. I still don't understand why they would move from a multiarch image to an x86_64-only one.

I've been working on this for about a week, and just yesterday I finished a GitHub Actions pipeline that builds multiarch images for x64/arm/arm64. I currently have successful builds for 0.18.1-rc.2. In a future update for my script, I will have it use these, that way ARM users don't need to compile it anymore. I just ask for a little patience, I haven't been able to do any work on Lemmy Easy Deploy since I've been working on this pipeline :)

I also do want to qualify - don't get your hopes up until you see it running for yourself. Ultimately, I am just a DevOps guy, not a Lemmy maintainer. I haven't tested my ARM images yet, and while I did my best to get these to build properly, I can't fix everything. If anything else breaks due to running on ARM, it will be up to the Lemmy team to fix those issues (which is not likely anytime soon, if their updated x86_64 Dockerfiles are any indication).

But, fingers crossed everything goes smoothly! Keep an eye out for an update, I'm working hard on it, hopefully I can get it out in time for 0.18.1!


EDIT:

Putting my notes on this progress here:

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

3

Thanks for the update, I updated to 0.18.0 a few days ago and it worked perfect. I'm excited for the next update, hopefully the Lemmy devs dont make big updates like this in future releases.

1

Hey, appreciate all your work so far. No worries if it's not going to work :-)

1

Try again with the latest version of Lemmy Easy Deploy.

I am now building multiarch images for 0.18.x, and my script will now default to my multiarch images, so there is no longer a need to build it yourself :)

2

Any ideas how to solve this? Everthing works according to docker..

XXXXX@lemmy:~/Lemmy-Easy-Deploy$ ./deploy.sh

Lemmy-Easy-Deploy by ubergeek77 (v1.1.1)

Detected runtime: docker (Docker version 24.0.2, build cb74dfc) Detected compose: docker compose (Docker Compose version v2.18.1) Runtime state: ERROR

ERROR: Docker runtime not healthy. Something is wrong with your Docker installation. Please ensure you can run the following command on your own without errors: docker run --rm -it -v $(pwd):/host:ro hello-world

If you see any errors while running that command, please Google the error messages to see if any of the solutions work for you. Once Docker is functional on your system, you can try running Lemmy Easy Deploy again.

XXXXX@lemmy:~/Lemmy-Easy-Deploy$ sudo docker run --rm -it -v $(pwd):/host:ro hello-world [sudo] password for XXXXX:

Hello from Docker! This message shows that your installation appears to be working correctly.

To generate this message, Docker took the following steps:

  1. The Docker client contacted the Docker daemon.
  2. The Docker daemon pulled the "hello-world" image from the Docker Hub. (amd64)
  3. The Docker daemon created a new container from that image which runs the executable that produces the output you are currently reading.
  4. The Docker daemon streamed that output to the Docker client, which sent it to your terminal.

To try something more ambitious, you can run an Ubuntu container with: $ docker run -it ubuntu bash

Thanks!

1

This is really great. I wish I could use it, but unfortunately I'm already using a different reverse proxy and can't use the included Caddy instance. Perhaps someone else will be able to do something similar for those in my situation. Great work, though!

1
lemmy.onitato.com

Any tips on how to customize the favicon for my instance? Using the docker-compose method.

1
bertreply
lemmy.monster

Looks like my favicon populated when I uploaded an icon in the admin panel: yourlemmydomain/admin

*edit seems that I replied to a comment showing as new for me but was actually old.

1

Weird. I did upload an icon earlier this morning, but my site still doesn't have a favicon...

2
ubergeek77reply
lemmy.ubergeek77.chat

Ok nevermind to everything I just said before this edit.

Go into your instance settings and upload an icon. A favicon will be made for it automatically.

1
ubergeek77reply
lemmy.ubergeek77.chat

I use my own deployment and I've never had an issue with my favicon on Firefox, on both desktop and mobile. Maybe it's a weird browser caching thing?

2

Thanks! I didn't realize how big it was. I've scaled it down dramatically and we are all good. Thanks for your help!

2

Weird. I did upload an icon earlier this morning, but my site still doesn't have a favicon...

1

This is really cool! I was having issues with the websocket when trying to run the setup locally from the docs, but this worked smoothly out of the box! I'd be interested in adding a ./deploy.sh --migrate-export, and a ./deploy.sh --migrate-import, so people can export and import their volumes easily. This could be useful if people needed to upgrade their machines or move hosts

1

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.

-2