bona.cafe

module

v0.0.0-...-ff8e54b Latest Latest Go to latest Published: Mar 25, 2020 License: AGPL-3.0, AGPL-3.0-or-later

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/bonanov/bona.cafe

Links

Open Source Insights

README ¶

bona.cafe

K-pop oriented imageboard. Fork of cutechan.

Runtime dependencies

PostgresSQL >= 9.6
FFmpeg >= 3.1 shared libraries (libavcodec, libavutil, libavformat, libswscale) compiled with:
- libvpx
GraphicsMagick >= 1.3 shared library (Q16) compiled with:
- zlib
- libpng
- libjpeg
libjpeg(-turbo) shared library (6.2 or 8.0 ABI)
dlib >= 19.10 shared library

Build dependencies

FFmpeg, GraphicsMagick, libjpeg, dlib development files
Node.js >= 8.0 (for building client)
Go >= 1.9.2 (for building server)
GNU Build System
OptiPNG

Build

make

Setup

See go/bin/cutechan --help for server operation
Login into the admin account with the password password
Change the default password
Create a board from the administration panel
Configure server from the administration panel

Development

make serve runs the server
make client and make server build the client and server separately
make client-watch watches the file system for changes and incrementally rebuilds the client
make clean removes files from the previous compilation

License

AGPLv3+

Directories ¶

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

Path	Synopsis
go
src/meguca/assets Package assets manages imager file asset allocation and deallocation	Package assets manages imager file asset allocation and deallocation
src/meguca/auth Package auth determines and asserts client permissions to access and modify server resources.	Package auth determines and asserts client permissions to access and modify server resources.
src/meguca/cache Package cache provides an in-memory LRU cache for reducing the duplicate workload of database requests and post HTML and JSON generation	Package cache provides an in-memory LRU cache for reducing the duplicate workload of database requests and post HTML and JSON generation
src/meguca/cmd/cutechan
src/meguca/cmd/cutethumb Image/video thumbnailer, run as a separate process and potentially from separate user for security reasons.	Image/video thumbnailer, run as a separate process and potentially from separate user for security reasons.
src/meguca/cmd/stackblur
src/meguca/common TODO(Kagami): Somehow merge with server/errors.go	TODO(Kagami): Somehow merge with server/errors.go
src/meguca/config Package config stores and exports the configuration for server-side use and the public availability JSON struct, which includes a small subset of the server configuration.	Package config stores and exports the configuration for server-side use and the public availability JSON struct, which includes a small subset of the server configuration.
src/meguca/db Package db handles all core database interactions of the server	Package db handles all core database interactions of the server
src/meguca/feeds Package feeds manages client synchronization to update feeds and provides a thread-safe interface for propagating messages to them and reassigning feeds to and from clients.	Package feeds manages client synchronization to update feeds and provides a thread-safe interface for propagating messages to them and reassigning feeds to and from clients.
src/meguca/geoip
src/meguca/ipc Common structures and helpers to communicate between cutechan processes.	Common structures and helpers to communicate between cutechan processes.
src/meguca/lang Internationalization support.	Internationalization support.
src/meguca/parser Parses and verifies user-sent post data.	Parses and verifies user-sent post data.
src/meguca/server API error interface and centralized collection of all errors return by server.	API error interface and centralized collection of all errors return by server.
src/meguca/templates Post formatting renderer.	Post formatting renderer.
src/meguca/test Package test contains utility functions used throughout the project in tests	Package test contains utility functions used throughout the project in tests
src/meguca/util Package util contains various general utility functions used throughout the project.	Package util contains various general utility functions used throughout the project.
src/meguca/websockets Package websockets manages active websocket connections and messages received from and sent to them	Package websockets manages active websocket connections and messages received from and sent to them