v4 Admin Tools Location

rahul286 commented 6 years ago

Update

[x] Use option 5 i.e. /ee-admin for all tools. No need to give an option to override.

URLs will look like:

example.com/ee-admin/index.html
example.com/ee-admin/pma
example.com/ee-admin/mailhog
example.com/ee-admin/adminer
example.com/ee-admin/webgrind
example.com/ee-admin/redisadmin
example.com/ee-admin/anonometer

EasyEngine provides tools like phpMyAdmin, adminer, redis-cache viewer etc.

Also, there is a plan to allow users to add more admin tools over the time.

Now we are in last round of v4 development, we need to finalize where we would like to put admin tools.

Option 1 - Port 22222

For example.com site, example.com:22222 will load admin tools at sample URLs like:

example.com:22222/pma
example.com:22222/mailcatcher

Pros

Separate port so no conflict with any URL from example.com

Cons

Additional network config when running behind Cloudflare.
On AWS and some platform manual opening/whitelisting of port 22222 required. Not sure if this is a negative point or should be looked upon as a "feature"/safety net.

Option 2 - Single Subdomain for admin tools

For example.com site, eeadmin.example.com will load admin tools at sample URLs like:

eeadmin.example.com/pma
eeadmin.example.com/mailcatcher

Pros

No port-related network config issues

Cons

DNS level changes needed

Option 3 - Separate Subdomain for admin tools

For example.com site, each admin tool will be loaded on separate domains like:

pma.example.com
mailcatcher.example.com

Pros

No port-related network config issues

Cons

DNS level changes needed, especially wildcard DNS.
A site name in WordPress multisite (in subdomain mode) can conflict with admin tool name/subdomain.

Option 4 - Separate top-level dirs for each tool

For example.com site, admin tools will load at sample URLs:

example.com/pma
example.com/mailcatcher

Pros

Easy to set up.

Cons

Conflict with a URL from the application.

Option 5 - Single top-level dirs for all tool (like `wp-admin`)

For example.com site, admin tools will load at sample URLs:

example.com/ee-admin/pma
example.com/ee-admin/mailcatcher

Pros

Easy to set up.

Cons

Conflict with a URL from the application domain. But only one URL needs to be handled.

I am inclined towards option 5 and option 1 (in order of preference).

Helmi commented 6 years ago

For my personal usage I'd chose Option 2 or 5.

Option 2 for me would be kind of an "admin domain" that I point to my servers anyway and are part of the server naming like vx1.myserverdomain.com, vx2.myserverdomain.com etc. It would be a handy way for me to use this to reach the admin tools.

Definitely Option 5 would work too and could easily be setup to use this administrative (sub) domain too.

For Option 5 maybe provide the option on install to chose/change the default alias in case /ee or whatever the default will be will be needed for something else?

michacassola commented 6 years ago

Definitely Option 5 for the mentioned reasons. But please make it short maybe /eea/...

renatonascalves commented 6 years ago

Option 5.

Any other option would increase your number of support emails, issues and, tickets.

rahul286 commented 6 years ago

@michacassola two reasons to propose ee-admin

It sounds like wp-admin <3
Is unlikely to clash with a real word term. Shorters versions like ee ea or even eea may have some meaning in some language somewhere.

The problem is when clash happens, it will be on end users end. Imagine a write on blog pushing post with conflicting slug and they keep wondering why they cant see the post in front!

We will see if we can make it easy to change or configure slug.

So far we are also inclined towards option 5.

michacassola commented 6 years ago

@rahul286 Ok, then ee-admin it is. And I think you dont need to include a slug configrator as ee-admin will very very rarely interfer with anyones URL wishes.

rahul286 commented 6 years ago

@michacassola agree with you. Makes sense! :)

mbtamuli commented 6 years ago

Example section of docker-compose.yml, that is working with Traefik (#1036)

  mail:
    image: easyengine/mail
    restart: always
    command: ["-invite-jim=false"]
    labels:
      - "traefik.port=8025"
      - "traefik.enable=true"
      - "traefik.protocol=http"
      - "traefik.frontend.entryPoints=http"
      - "traefik.frontend.rule=Host:${VIRTUAL_HOST};PathPrefixStrip:/ee-admin/mailhog/"
    networks:
      - site-network

  phpmyadmin:
    image: easyengine/phpmyadmin
    restart: always
    environment:
      - PMA_ABSOLUTE_URI=http://${VIRTUAL_HOST}/ee-admin/pma/
    labels:
      - "traefik.port=80"
      - "traefik.enable=true"
      - "traefik.protocol=http"
      - "traefik.frontend.entryPoints=http"
      - "traefik.frontend.rule=Host:${VIRTUAL_HOST};PathPrefixStrip:/ee-admin/pma/"
    networks:
      - site-network

CC: @mrrobot47

mbtamuli commented 6 years ago

This is being worked on in EasyEngine/site-command#15

michacassola commented 6 years ago

Original Admin-Tools location Issue can be closed?

michacassola commented 6 years ago

Sorry for the question in case it was answered already, but I couldn't find anything:

@rahul286 @mbtamuli Will you make it possible to have Roundcube in some way in v4? (The new Elastic Theme will be really great!) If yes but you would like to do it later should I make another Issue here in GitHub?

rahul286 commented 6 years ago

@michacassola sorry to say there won't be Roundcube as we won't be supporting webmail hosting anymore in v4 core or official addons.

renatonascalves commented 6 years ago

I think it is the right approach. nobody should be hosting or dealing with email in their own servers.

I also think this new strategy will decrease support and ease the management of the package/tool.

On Tue, Jun 26, 2018, 13:02 Rahul Bansal notifications@github.com wrote:

@michacassola https://github.com/michacassola sorry to say there won't be Roundcube as we won't be supporting webmail hosting anymore in v4.

— You are receiving this because you commented. Reply to this email directly, view it on GitHub https://github.com/EasyEngine/easyengine/issues/1013#issuecomment-400366646, or mute the thread https://github.com/notifications/unsubscribe-auth/ASQwotAhJ8Vd1ATpVTNogOqCBDF5uxprks5uAlsOgaJpZM4URHvs .

michacassola commented 6 years ago

@rahul286 Thank you for the quick answer. So I will have to install Roundcube myself then with only php and mysql being enabled.

@renatonascalves One should definitely separate Webhosting from Email Hosting! But if nobody'd be hostin' email, there would be no email. ;) But kidding aside: I don't host my own email, its a pain in the butt to setup in a good way and when you think your done you have to go begging the big guys to whitelist your neutral reputation IP. I just need Roundcube as a Client for Whitelabeling purposes, but installing it could also be easier so I was just wondering.

michacassola commented 6 years ago

Wasn't so bad to install Roundcube in EE v3 after all, works fine with the remote email server.

So another dumb question @rahul286: Please tell me that v4 will support to create php and mysql sites only like v3: ee site create bla.com --php7 --mysql --le

mbtamuli commented 6 years ago

@michacassola Yes. There will be a option to create a site with PHP and MySQL only. Although we might be using some different flags and the old style will be deprecated and.

Any change we make from EEv3 will be documented.

mbtamuli commented 6 years ago

Admin tools has been added in https://github.com/EasyEngine/site-command/pull/15

renrayut commented 6 years ago

Hi , after i install admin-tools and enable for ee site up (sitename) then try to access /ee-admin it not show something . how to fixed it ?

mrrobot47 commented 6 years ago

@renrayut This issue has been reported here: https://github.com/EasyEngine/dockerfiles/pull/34 and has been fixed. It will be released very soon in the coming rc release.

EasyEngine / easyengine