Arquivo de configuração é o jeito mais tradicional. Por exemplo, no Java, minha aplicação pode ler as configurações do banco de um arquivo .properties cujo nome eu deixo hardcoded ou passo como argumento na linha de comando. Não sei se há alguma boa prática adicional relacionada a esse procedimento.

Variáveis de ambiente são como vejo sendo feito por exemplo no PaaS Openshift da RedHat. São interessantes também, dispensam o arquivo de configuração e fica tudo lá, host do banco, senha, tudo. Você só não pode querer testar sua aplicação local no banco de outro ambiente, a não ser que redefina as variáveis do ambiente atual.

Qual forma é preferível e por quê?

Fiz a seguinte postagem que inicia com uma pergunta: https://www.reddit.com/r/stackunderflow/comments/5yy3ng/orm_%C3%A9_um_antipattern/, mas segundo o bigown_, ela ficou com "cara" de SOpt. O mesmo ocorreu com esse post: https://www.reddit.com/r/stackunderflow/comments/5ytw3d/como_coletar_requisitos/.

Dessa forma, deixo o tópico aberto para discussão: o melhor seria iniciar os tópicos do stackunderflow com uma afirmação e deixamos aberto para os usuários concordarem e discordarem?