설치¶

설치 전 준비사항¶

• 파이썬 3.8 이상의 버전이 필요합니다.
• Git을 사용한 설치를 권장합니다.

• 루트 디렉토리에 .env 파일이 없는 경우에도 설치 과정 중 자동으로 생성됩니다.

  Warning

  example.env 파일을 삭제하지 않도록 주의하세요.

그누보드6 설치¶

1. git clone (추천)¶

1. 터미널¹을 열고 git² 명령을 사용하여 그누보드6를 설치합니다.

   git clone https://github.com/gnuboard/g6.git
   

   

   

2. 그누보드6 디렉토리로 이동합니다.

   cd g6
   

3. 가상환경을 만듭니다.

   # 가상환경 (venv) 생성
   python -m venv venv
   # 또는
   python3 -m venv venv
   
   # 가상환경 실행
   # Linux
   source venv/bin/activate
   
   # Windows
   source venv\Scripts\activate
   # 또는 
   source venv/Scripts/activate
   

4. 그누보드6에서 사용할 파이썬 필수 패키지들을 pip를 이용하여 설치합니다.

   pip install -r requirements.txt
   # 또는 
   pip3 install -r requirements.txt
   

그누보드6 실행¶

• uvicorn 명령을 사용하여 실행합니다. 기본적으로 8000번 포트를 사용합니다.

uvicorn main:app --reload --host 0.0.0.0 --port 8000

uvicorn main:app --reload

브라우저 데이터베이스 설정¶

1. 처음 접속하면 .env 파일이 없습니다. 설치를 진행해 주세요. 라는 경고창과 함께 설치 페이지로 이동합니다.

   

2. 설치 메인 페이지에서는 설치할 그누보드 버전, 파이썬 버전, FastAPI 버전 및 관련 안내 사항을 확인할 수 있습니다.

   

3. 그누보드6 라이센스를 확인하고 동의합니다.

   

4. 데이터베이스 설정을 진행합니다.

   • MySQL, PostgreSQL, SQLite 중 하나의 데이터베이스를 선택하여 설정할 수 있습니다.
     • SQLite : 연결정보가 필요 없으며, 루트 디렉토리에 sqlite3.db 데이터베이스 파일이 생성됩니다.
     • MySQL, PostgreSQL : 연결에 필요한 정보들을 입력합니다.
   • 데이터베이스 테이블 접두사를 입력합니다.
     • {영문+숫자}_ 형식으로 입력해야 합니다.
     • 기본값은 g6_ 입니다. (예: gnuboard6_)

   • 재설치 여부를 체크합니다. (선택)

     재설치 주의

     재설치는 테이블을 삭제 후 재생성합니다. 기존 데이터가 망실될 수 있으니 주의하시기 바랍니다.

   

5. 관리자 정보를 입력합니다. 입력한 정보를 바탕으로 관리자 계정이 생성됩니다.

6. 설치를 진행합니다. 설치 내용에 따라 순차적으로 진행되며, 설치가 완료되면 설치완료 문구가 출력됩니다.

   

7. 이제부터 자유롭게 그누보드6를 사용할 수 있습니다.