.env.example 이란

해당 프로젝트를 실행하려면 어떠한 환경변수가 필요한지 알려주는 견본 파일

 

DB_HOST=localhost
DB_PASSWORD=
OPENAI_API_KEY=

어떠한 값이 필요한지 보여주는 역할을 한다. 값을 넣어서 공개하지 않는다.

---

사용법

# 두 가지 방법으로 자유롭게 사용. .gitignore에서 추적하지 않는 대상으로 복사 하면 됨
cp .env.example .env.local
cp .env.example .env

cp 명령을 통해, .env.example의 내용물을 복사해서 파일을 생성할 수 있다.

 

---

연관된 gitignore의 문법

# case 1
.env*

# case 2
!.env.example

가끔 gitignore에 위처럼 작성된 경우가 있다.

 

1. case 1

.env 로 시작하는 파일을 전부 무시(추적 안함)하라는 것이다.

따라서 아래의 같은 파일들이 전부 무시된다.

.env
.env.local
.env.production
.env.example

1. case 2

.env로 시작하지만 .env.example을 예외로 두고싶다면, case 2대로 하면 git이 추적할 수 있다.

 

---

경험하기

실제고 git 초기화를 진행하고 .env* 를 등록해보았다.

 

.env로 시작하는 환경변수 파일들이 추적되지 않는 것을 확인할 수 있다.

 

!.env.exmaple 예외처리를 해본다

 

.env.example 이란

해당 프로젝트를 실행하려면 어떠한 환경변수가 필요한지 알려주는 견본 파일

 

DB_HOST=localhost
DB_PASSWORD=
OPENAI_API_KEY=

어떠한 값이 필요한지 보여주는 역할을 한다. 값을 넣어서 공개하지 않는다.

---

사용법

# 두 가지 방법으로 자유롭게 사용. .gitignore에서 추적하지 않는 대상으로 복사 하면 됨
cp .env.example .env.local
cp .env.example .env

cp 명령을 통해, .env.example의 내용물을 복사해서 파일을 생성할 수 있다.

 

---

연관된 gitignore의 문법

# case 1
.env*

# case 2
!.env.example

가끔 gitignore에 위처럼 작성된 경우가 있다.

 

1. case 1

.env 로 시작하는 파일을 전부 무시(추적 안함)하라는 것이다.

따라서 아래의 같은 파일들이 전부 무시된다.

.env
.env.local
.env.production
.env.example

1. case 2

.env로 시작하지만 .env.example을 예외로 두고싶다면, case 2대로 하면 git이 추적할 수 있다.

 

---

경험하기

실제고 git 초기화를 진행하고 .env* 를 등록해보았다.

 

.env로 시작하는 환경변수 파일들이 추적되지 않는 것을 확인할 수 있다.

 

!.env.exmaple추적하기 시작한다.

 

# 기본 형태
git check-ignore -v <파일명>

# 사용 예시
git check-ignore -v .env
git check-ignore -v .env.local

check-ignore 명령으로 해당 파일이 어떤 .gitignore 규칙때문에 추적이 무시되는지도 확인할 수 있다

 

왼쪽에 보이는가? 실제로 .gitignore의 첫번째 라인에 .env*규칙이 명시되어있다.