Skip to content
openNAMUPublic

About

여러 기능이 있는 위키 엔진 (Wiki engine with multiple functions)

Topics

Resources

Stars

252 stars

Watchers

9 watching

Forks

Latest commit

 

History

684 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

(en-US) | (ko-KR)

오픈나무

Go 1.26 이상 라이선스

오픈나무는 Go 기반의 위키 엔진입니다.

시작하기

릴리즈 페이지에서 사용하는 운영체제와 아키텍처에 맞는 바이너리를 내려받아 실행할 수 있습니다.

릴리즈 페이지에서 다음 파일 중 하나를 내려받으세요.

운영체제 바이너리
Linux amd64 main.amd64.bin
Linux arm64 main.arm64.bin
Windows amd64 main.amd64.exe
Windows arm64 main.arm64.exe
macOS arm64 main.mac.arm64.bin

Linux

./main.amd64.bin

Docker Hub

이미지는 linux/amd64, linux/arm64를 지원합니다. latest는 정식 릴리즈에만 갱신되므로 버전을 고정하려면 버전 태그를 사용하세요.

docker run -d --name opennamu --restart unless-stopped \
  -p 3000:3000 \
  -v opennamu-data:/data \
  opennamu/opennamu:latest

/data 볼륨에 DB, data/set.json, 업로드 파일 등 실행 중 생성되는 데이터가 저장됩니다. 새 이미지로 컨테이너를 교체할 때도 이 볼륨을 유지하세요. 이미지는 UID/GID 10001로 실행됩니다. Docker named volume은 바로 사용할 수 있지만, 호스트 디렉터리를 bind mount할 때는 해당 UID가 쓸 수 있어야 합니다. 컨테이너에서는 openNAMU 자체 바이너리 업데이트 대신 새 이미지를 받아 교체하세요.

Alpine Linux

정제된 Linux 바이너리는 glibc 호환 런타임 라이브러리가 필요합니다. Alpine Linux는 musl libc를 사용하므로 추가 호환 패키지가 필요합니다.

SQLite는:

apk add --no-cache gcompat

Turso는:

apk add --no-cache gcompat libgcc

필요한 패키지를 설치한 후 표준 Linux 바이너리를 보통 그대로 실행하면 됩니다.

이 지침은 Alpine Linux 3.19(amd64)에서 확인되었습니다. 다른 Alpine 버전과 arm64는 아직 확인되지 않았습니다.

Windows

.\main.amd64.exe

기본 포트는 3000이며, 실행 시 첫 번째 인자로 변경할 수 있습니다.

./main.amd64.bin 3000

외부에서 접근하지 않고 같은 컴퓨터에서만 사용할 때는 --localhost를 추가합니다.

./main.amd64.bin --localhost
./main.amd64.bin 3000 --localhost

서버가 정상적으로 시작되지 않을 때는 이머전시 툴을 실행할 수 있습니다.

./main.amd64.bin em

개발자용

소스 코드를 수정하거나 직접 빌드하려는 경우에 참고하세요.

클론

아래 명령을 터미널(명령 프롬프트)에 입력하여 본 리포지토리를 클론할 수 있습니다.

  • 일반: git clone -b stable https://github.com/openNAMU/openNAMU.git
  • 베타: git clone -b beta https://github.com/openNAMU/openNAMU.git

빌드 및 테스트

소스에서 빌드하려면 Go 1.26 이상이 필요합니다.

./linux.sh linux_amd64

Windows에서는 다음 명령을 사용할 수 있습니다.

.\windows.ps1 windows_amd64

직접 빌드하려면 다음 명령을 사용할 수 있습니다.

go build -o main .
./main

변경 사항을 확인할 때는 다음 명령을 사용할 수 있습니다.

go test ./...
go vet ./...

Docker Hub 이미지 게시 (관리자)

태그 릴리즈 워크플로는 바이너리 릴리즈가 성공한 뒤 멀티아키텍처 이미지를 게시합니다. 활성화하려면 GitHub Actions 저장소 변수 DOCKERHUB_PUBLISH를 true로 설정하고, Docker Hub 액세스 토큰을 DOCKERHUB_TOKEN 시크릿으로, 로그인 이름을 DOCKERHUB_USERNAME 시크릿으로 등록하세요. 필요하면 DOCKERHUB_IMAGE 변수에 소문자 namespace/repository 이름을 설정합니다. 기본 이미지는 opennamu/opennamu입니다. 버전 태그는 그대로 게시하고, 하이픈이 없는 정식 태그만 latest를 갱신합니다.

데이터베이스 설정

기본 설정은 data/set.json에서 지정합니다.

{"db_type":"sqlite","db":"data"}

위 설정에서는 실행 디렉터리의 data.db를 SQLite 데이터베이스로 사용합니다. 설정이 없으면 SQLite의 data.db를 기본값으로 사용합니다.

MySQL을 사용하려면 data/set.json을 다음처럼 작성하고 data/mysql.json에 접속 정보를 넣습니다.

{"db_type":"mysql","db":"openNAMU"}
{"user":"username","password":"password","host":"127.0.0.1","port":"3306"}

Turso 엔진(로컬 파일)을 사용하려면 db_type을 turso로 지정합니다. 파일 이름은 SQLite와 같은 방식으로 해석되며, 서버나 네트워크 접속 없이 data.db를 Turso 임베디드 드라이버로 엽니다.

{"db_type":"turso","db":"data"}

turso를 선택하면 MVCC 저널 모드(journal_mode = mvcc)가 기본 적용되어 동시 쓰기 충돌이 완화됩니다. 단, MVCC는 아직 실험적 기능이므로 중요한 위키 데이터는 정기적으로 백업하세요. 제약 사항은 다음과 같습니다.

  • Turso로 데이터를 쓴 뒤 db_type을 sqlite로 되돌리려면 먼저 체크포인트를 실행해야 변경 사항이 보입니다.
  • 서버 실행 중 데이터베이스 파일을 sqlite3 CLI 등 다른 프로세스로 열지 마세요.
  • windows/arm64 바이너리에서는 turso를 선택할 수 없습니다(기본 제공 라이브러리 미제공).

기존 데이터베이스를 전환하기 전에는 반드시 데이터베이스와 설정 파일을 백업하세요.

현재 상태

오픈나무는 현재 beta 단계입니다.

  • Go 단일 서버로 실행합니다.
  • SQLite, MySQL, Turso(임베디드)를 지원합니다.
  • 기본 스킨과 언어 데이터는 바이너리에 포함됩니다.

역방향 프록시 / IP 식별

오픈나무는 IP를 가져올 헤더 설정에 따라 직접 TCP 연결 또는 전달 헤더에서 클라이언트 주소를 가져옵니다. 신뢰할 프록시 필드는 쉼표나 줄바꿈으로 구분한 IP 주소/CIDR 네트워크이며, 직접 연결 대시(접속 원)가 여기 포함된 경우에만 X-Real-IP 또는 CF-Connecting-IP 헤더가 적용됩니다. 프록시/리버스 프록시 주소를 기재하십시오(클라이언트 주소가 아닙니다). 공백이면 신뢰할 프록시가 없어 직접 연결 주소가 사용됩니다. 0.0.0.0/0 / ::/0은 거부됩니다.

  • nginx: nginx 주소를 신뢰할 프록시에 추가하고 IP를 가져올 헤더를 HTTP_X_REAL_IP로 설정하세요(proxy_set_header X-Real-IP $remote_addr;. 신뢰할 프록시가 없으면 오픈나무는 nginx 주소를 봅니다).
  • Cloudflare: IP를 가져올 헤더를 HTTP_CF_CONNECTING_IP로 설정하고 Cloudflare 엿지 IP 구간을 신뢰할 프록시에 추가하십시오.
  • Python WSGI (app.py): 브리지는 클라이언트가 보낸 IP 전달 헤더를 검증된 WSGI REMOTE_ADDR로 대체합니다. WSGI 앞에 역방향 프록시가 있다면 직접 연결 프록시를 검증한 뒤에만 WSGI 서버/프록시 미들웨어가 클라이언트 IP를 REMOTE_ADDR에 설정하도록 구성하십시오. 그렇지 않으면 오픈나무는 WSGI 피어 주소를 사용합니다. Go 백엔드에서는 WSGI-to-Go 피어(일반적으로 127.0.0.1)만 신뢰할 프록시에 추가하고 전달 헤더 모드를 사용해야 해당 주소가 적용됩니다. 이 설정이 없으면 Go는 전달 헤더를 무시하고 피어 주소를 사용자 식별자로 사용하므로 전체 루프백 대역을 신뢰하거나 브리지 주소에 높은 IP 권한을 부여하지 마십시오.

설정을 변경한 뒤 오픈나무를 재시작하십시오.

기여

오픈나무에는 확인되지 않은 버그가 존재할 수 있습니다. 이를 보고해주시면 오픈나무의 발전을 도울 수 있습니다. 여기를 눌러 버그를 보고해주세요.

오픈나무는 오픈소스 프로젝트입니다. 원한다면 직접 코드를 수정하고 Pull Request를 보낼 수 있습니다.

라이선스

오픈나무 프로젝트는 BSD 3-Clause License를 따릅니다. 자세한 내용은 문서를 참고하세요.

포함된 외부 프로젝트

도움을 주신 분들

지원 문법

  • 나무마크 (NamuMark)
  • 마크다운 (Markdown)
  • MacroMark
  • Raw

기타

About

여러 기능이 있는 위키 엔진 (Wiki engine with multiple functions)

Topics

Resources

Stars

252 stars

Watchers

9 watching

Forks

Releases

Packages

Used by

Contributors

Languages