Instructions for Portainer

[RingBandit]

Have you read a contributing guide?

• I have read CONTRIBUTING.md
• I have searched the existing requests and didn't find any that were similar
• I have considered creating a pull request instead and want to proceed

Clear and concise description of the problem

I'm trying to setup AnyType for Personal use in my local home network in Portainer.
I already got the Custom Template which pulls the docker-compose.yml from here basically:
https://github.com/anyproto/any-sync-dockercompose/blob/main/docker-compose.yml

The Git Settings look like this:

But when I try to deploy a Stack from the Template, it looks like this:

I'm assuming I'll have to add environment variables for the Volume Z mentioned in the compose-file, but to be completely honest with you, I don't get the Instructions in the Wiki nor do I get the instructions on how to use the env.override file, especially when not setting this up in the Terminal but in Portainer. I can give it an .env file or configure variables manually, but I do not see an option to add or configure .env.override files.

Suggested solution

Can you please add instructions on what variables are mandatory to set and how to set them when using any GUI Frontend for Docker-Compose like Portainer Template and Stacks or the Synology Container Manager Projects?

Alternative

Any alternative solution that would enable me to deploy a working stack of AnyType on my local home server using a template pulled from github like you can see above in the "Clear and concise description of the problem" Section.

Additional context

No response

[fb929]

we don’t use a GUI frontend for Docker Compose, so I can’t give specific instructions on how to configure it.

I assume Portainer provides a Bash console - if so, you can run make start there.
if make is not available, you can execute the commands manually according to the instructions.

if that's not possible, the simplest solution would be to generate the configuration beforehand on another host and then transfer it to your Portainer host.

to do this on any Unix host (Linux or MacOS):

1. clone this repository.

2. configure the necessary variables in .env.override (at minimum, set EXTERNAL_LISTEN_HOSTS).

3. run the configuration generation command:

   make generate_env

after that, a .env file and the directories ./etc/ and ./storage/ will be generated.
You’ll need to copy all of these to the any-sync-dockercompose directory on your Portainer host.

[RingBandit]

Okay, I've now connected to the Host-System of the Docker-Environment, which is a Linux System and I've run the make processes like you told me here, but in Portainer it looks like some of the Containers exited with error code 0. Also I've tried to use only EXTERNAL_LISTEN_HOSTS="127.0.0.1", but looking at the resulting client.yml I think this will not work. What IP do I have to enter here exactly? The Router IP? The Home Network's DNS-Server's IP? Or the IP of the Linux Host? Or the IP of the Proxmox Server in my Home Network? Or do I have to enter the IP's of every single Client that will ever connect? Or do I have to enter any free IP of the DHCP-Server from my Host Network or could I use DHCP in that case? I just don't get what an External Listen Host IP Address should be and the instructions are not clear on that, at least to me.

[RingBandit]

I just found out, that the variable is just for creating this file, is that right? so, it should be the Host's IP-Address, because then it's gonna replace the default one with the one of the Host, so I can just throw that client.yml at a client and it will know how to connect?
If my assumption is right, I could just manually replace all the 127.0.0.1 occurrences with the IP of the Docker-Host, right?

[fb929]

EXTERNAL_LISTEN_HOSTS must contain the IP addresses (or hostnames) that clients will use to access the server.
usually, these are the private and public (if any) IP addresses of the server running the self-host.

no, you cannot manually replace the IP address with the Docker-Host’s IP, because the addresses are also written into the database as part of the "network configuration".
You must add IP addresses only through .env.override and then regenerate the configuration.

also, keep in mind that the ./storage/ directory contains self-hosted data.
therefore, if you repeatedly copy the storage from a Linux system where you only generate the configuration, you may corrupt the data on the self-hosted instance (if you have already started using it and it contains any client data).

[RingBandit]

Okay, I removed everything, cloned the repo anew, echoed the mounted storage directory and the listening IP (which is the IP of the Debian System playing the role of a Docker Host System), but at step 17/17 there is an Error stating the Mongo-1-1 Container:

Any Idea why?

[linellazatin]

Okay, I removed everything, cloned the repo anew, echoed the mounted storage directory and the listening IP (which is the IP of the Debian System playing the role of a Docker Host System), but at step 17/17 there is an Error stating the Mongo-1-1 Container: Any Idea why?

can you check the docker logs of that container? it should say more about what's happening - like permission denied errors, unsupported protocols, etc.

[RingBandit]

I think this might be the interesting part, but I don’t get why this happens, because I can see that AnySync already created some folders and files on the mounted volume.

[linellazatin]

I think this might be the interesting part, but I don’t get why this happens, because I can see that AnySync already created some folders and files on the mounted volume.

the thing is, by default mongodb does not allow itself to operate on root perms - you could either allow all to read write in that mounted vol, or add whatever user mongo uses. I would suggest to modify user access to that mount and check further.

Also, what kind of mount/share is that? I've encountered and tried smb shares for mongodb and it doesn't work - unsupported protocol - just a warn for you, once you got that perm error off of your stack

[RingBandit]

What are you suggesting to use for Storage, other than smb shares? Will smb shares work in the future?

[linellazatin]

What are you suggesting to use for Storage, other than smb shares? Will smb shares work in the future?

no idea on mongo's future - all I know is that it's using its own Wire as protocol. for now, atleast for your quick and dirty fix of this, and to kickoff your app operations and test, I would suggest that you point your storage to your local dirs

Edit: grammar lol