Using --add-host or extra_hosts with docker-compose

Question

I am using docker-compose to run a test environment, that consists of about 5 different containers. The inter-container links and the shared volumes (volumes-from) works wonderfully. I also expose some ports up to the host machine, which works nicely.

What I am missing is a way to link some of my real servers into this environment, without hardcoding ip address. With docker run, you could use --add-host to add another line in your /etc/hosts file. Is there any way to do something similar with docker-compose?

oneklc · Accepted Answer · 2021-03-10 03:08:34Z

203

https://github.com/compose-spec/compose-spec/blob/master/spec.md#extra_hosts

extra_hosts - Add hostname mappings. Uses the same values as the docker client --add-host parameter.

extra_hosts:
 - "somehost:162.242.195.82"
 - "otherhost:50.31.209.229"

An entry with the ip address and hostname will be created in /etc/hosts > inside containers for this service, e.g:

162.242.195.82  somehost
50.31.209.229   otherhost

edited Mar 10, 2021 at 3:08

answered Oct 23, 2015 at 22:26

oneklc

3,3141 gold badge23 silver badges13 bronze badges

Sign up to request clarification or add additional context in comments.

6 Comments

expelledboy Over a year ago

Not supported on build

Adriano dos Santos Fernandes Over a year ago

How can I map an external name (not an IP) to a container alias?

oneklc Over a year ago

You mean set a hostname? -h HOSTNAME docs.docker.com/engine/userguide/networking/default_network/… Or use an alias in docker-compose: docs.docker.com/compose/compose-file/#aliases

J Cracknell Over a year ago

extra_hosts appears to be supported as an undocumented subkey of build, at least on compose 2.4.1.

solosuper Over a year ago

It should be also supported on build now: github.com/compose-spec/compose-spec/blob/master/…

|

Gilles Quénot · Accepted Answer · 2023-08-29 04:15:02Z

151

This works still docker-compose 1.3 with extra_hosts parameter:

rng:
  build: rng
  extra_hosts:
    seed: 1.2.3.4
    tree: 4.3.2.1

edited Aug 29, 2023 at 4:15

Gilles Quénot

188k43 gold badges232 silver badges229 bronze badges

answered May 30, 2015 at 1:56

jpetazzo

15.6k4 gold badges45 silver badges46 bronze badges

4 Comments

Prasanth Over a year ago

For any one finding this to error out saying unsupported config directive "extra-hosts" it's not "extra-hosts" it's "extra_hosts".

Dave Over a year ago

The format here, of a nested dictionary, is out of date. This answer stackoverflow.com/a/61231167/1497199 is more up to date.

oligofren Over a year ago

@Dave No, it is NOT out of date. If you should have the wrong format, docker-compose will tell you: services.imageproxy.extra_hosts contains an invalid type, it should be an object, or an array. And object is one of two options. Far preferrable to a string, IMHO.

Code Guru Over a year ago

i have added this extra_hosts: - "host.docker.internal:host-gateway" but still it is saying in logs that connection refused

LondonRob · Accepted Answer · 2024-07-31 08:18:50Z

133

Basic docker-compose.yml with extra hosts:

version: '3'
services:
api:
    build: .
    ports:
        - "5003:5003"
    extra_hosts:
        - "your-host.name.com:162.242.195.82" #host and ip
        - "your-host--1.name.com your-host--2.name.com:50.31.209.229" #multiple hostnames with same ip

The content in the /etc/hosts file in the created container:

162.242.195.82  your-host.name.com
50.31.209.229   your-host--1.name.com your-host--2.name.com

You can check the /etc/hosts file with the following commands:

$ docker-compose -f path/to/file/docker-compose.yml run api bash  # 'api' is service name
#then inside container bash
root@f7c436910676:/app# cat /etc/hosts

edited Jul 31, 2024 at 8:18

LondonRob

79.8k43 gold badges161 silver badges224 bronze badges

answered Apr 15, 2020 at 14:23

Shubham

2,2702 gold badges17 silver badges17 bronze badges

Collectives™ on Stack Overflow

Using --add-host or extra_hosts with docker-compose

3 Answers 3

6 Comments

4 Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

6 Comments

4 Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related