macOS compatibility

[juliendargelos]

What problem will this feature address?

Dokploy is only meant to run on Linux. It would be great if it could also work on macOS.

Describe the solution you'd like

Make the production version of Dokploy compatible with macOS.

Describe alternatives you've considered

I considered switching my local server OS from macOS to Linux. But it would mean loosing some Apple-specific features I rely on.

Additional context

I recognize macOS compatibility is not particularly relevant for production-grade setups, yet I think Dokploy is also great as a local development platform and local network PaaS. Being able to run it on macOS could greatly enhance those use cases.

I could identify some platform-specific code that would need to be adapted, but I'm not sure how much this project depends on Linux. I may need some directions if I tried to implement this compatibility.

Will you send a PR to implement it?

Maybe, need help

[Siumauricio]

My personal computer Is MacOS and I use to develop new features and bug fixes, so you shouldn't have any issues in your mac

[juliendargelos]

I thought Dokploy was not meant to run on macOS at all, primarily because of this condition in the install script:

#!/bin/bash
install_dokploy() {
    # ...

    # check if is Mac OS
    if [ "$(uname)" = "Darwin" ]; then
        echo "This script must be run on Linux" >&2
        exit 1
    fi

    # ...
}

Or, for instance, this exception in server-setup.ts:

dokploy/packages/server/src/setup/server-setup.ts

Lines 387 to 388 in ff20bb2

	echo "This script only supports Debian, Redhat, Arch Linux, or SLES based operating systems for now."
	exit

And also because of many Linux-specific binaries used by Dokploy such as pacman, systemctl, dnf, apt-get, ss, ...

Am I missing something about how this should be installed on macOS ?

[divaltor]

I thought Dokploy was not meant to run on macOS at all, primarily because of this condition in the install script:

#!/bin/bash
install_dokploy() {
# ...

# check if is Mac OS
if [ "$(uname)" = "Darwin" ]; then
    echo "This script must be run on Linux" >&2
    exit 1
fi

# ...

}

Or, for instance, this exception in server-setup.ts:

dokploy/packages/server/src/setup/server-setup.ts

Lines 387 to 388 in ff20bb2
echo "This script only supports Debian, Redhat, Arch Linux, or SLES based operating systems for now."
exit

And also because of many Linux-specific binaries used by Dokploy such as pacman, systemctl, dnf, apt-get, ss, ...

Am I missing something about how this should be installed on macOS ?

Dev instance is running fine on MacOS (see CONTRIBUTING.MD file), are you trying to host production version on MacOS server?

[juliendargelos]

Yeah this is what I would like. I think my issue description wasn't clear but it was not about a development setup of Dokploy, what I meant by "Make Dokploy compatible with macOS." was "Make the production version of Dokploy compatible with macOS".

That's why I did not initially categorize the issue as a bug or question but more as an enhancement.

My use case is about running it on my personnal server to deploy various services on my local network, and this server uses macOS.

[divaltor]

I see, though I don't know much about Dokploy deployment, but I think main use case of Dokploy is to be deployed on basic Linux machines provided by most providers.

MacOS is non-standart server by definition and for example if'll open server-setup.ts we can see that we use default package managers from each system (pacman, apt), but MacOS doesn't have one by default and we would need to install something like brew on such server, I think.

If you could provide a reason for maintainers why would you need to deploy Dokploy on MacOS rather than Linux (Ubuntu, Debian, Arch) I think they would clearly understand should they support that or not. May be someone would like to contribute as well if you can suggest where we can rent MacOS server for debugging purposes at least

Thanks

[sommersdev]

I have a Macbook and will make try to make a branch that that will only work on macos. This could take some days, weeks or months, but the best method is just using a WM for now or deploy docker projects directly in docker desktop.

[juliendargelos]

If you could provide a reason for maintainers why would you need to deploy Dokploy on MacOS rather than Linux (Ubuntu, Debian, Arch) I think they would clearly understand should they support that or not.

The main reason my home server runs on macOS — and not a more common os for a server — is because it also needs some Apple-specific programs such as HomeKit, Shortcuts, Apple Music or AppleScript.

Honestly I think my use case is pretty marginal, I totally understand why it wouldn't be a priority. The purpose of this issue was mainly to write it down somewhere, since I couldn't find anyone else mentioning it.

[Siumauricio]

Yeah this is what I would like. I think my issue description wasn't clear but it was not about a development setup of Dokploy, what I meant by "Make Dokploy compatible with macOS." was "Make the production version of Dokploy compatible with macOS".

That's why I did not initially categorize the issue as a bug or question but more as an enhancement.

My use case is about running it on my personnal server to deploy various services on my local network, and this server uses macOS.

That makes more sense. I thought you were referring to whether dokploy could be run locally. I haven't really had the opportunity to try installing it on a Mac machine. I don't think it's very common, so I only installed it based on the most common distributions.

It probably doesn't take much work to get it to work, since dokploy doesn't do anything magical at the end of the day. They're just containers that run on a machine and give you an interface.

I don't have a way to test this, but maybe modifying the installation command or trying it out will work for you! https://github.com/Dokploy/website/blob/main/apps/website/public/install.sh

[porterporter]

I don't have a way to test this, but maybe modifying the installation command or trying it out will work for you!

This works! I use a M4 Mac Mini as a VPS because it's what I have and this works perfectly!

[juliendargelos]

I don't have a way to test this, but maybe modifying the installation command or trying it out will work for you!

This works! I use a M4 Mac Mini as a VPS because it's what I have and this works perfectly!

@porterporter

Could you share the install script you used ?

[porterporter]

I used the regular install script they provide, but ran the commands à la carte.
https://github.com/Dokploy/website/blob/main/apps/website/public/install.sh

The main differences was finding the private IP ipconfig getifaddr en<0/1>, and then I changed some of the volume mounts from /etc/* on my machine to just a local folder.

Basically swarm init, create network, create postgres service, create redis service, create dokploy service (with mounts changed), run traefik (with mounts changed), connect networks, then visit the IP at port 3000

Haven't done enough testing to see if everything runs correctly, but so far I haven't run into any issues. If maintainers wanted to support darwin natively, all they'd really have to do is change the install script just a little bit.

[mgonter]

Ok. I made some changes to the script for mac only, but it's not really all that product. Easy to make it that way, just don't have the itme for it.

1. Remove the macOS check in the install_dokply function (lines 42-46.
2. Update the get private ip with osascript -e "IPv4 address of (system info)"

You can set the variable ADVErTISE_ADDR if you'd like, but you'll need to set it for root since it's running as root. Your mileage is going to vary on how your network setup is on your mac.

If I was making this more production focused, I'd add logic to check if it was linux vs mac and update varabliles accordingly. Also provide the ability to select which mac interface you'd like to set as the private IP.

[cheonkyu]

I've submitted a Pull Request to the dokploy/website repository to address this macOS installation issue. Since the install.sh source code is located there, I've implemented the macOS support and Swarm initialization fixes in that repo.

You can check the PR here: Dokploy/website#140

This fix includes OS detection, portable port checking, and specific Swarm init guidance for Docker Desktop users. Hope this helps!