tetuca

command module

v2.5.1+incompatible Latest Latest Go to latest Published: Oct 23, 2016 License: AGPL-3.0, AGPL-3.0-or-later Imports: 1 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/0-chan-ru/tetuca

Links

Open Source Insights

README ¶

Platforms: Linux, OSX, Win64

License: GNU AGPL

##Runtime dependencies

RethinkDB. On Linux RethinkDB does not enable a configuration file by default. If you don't want to configure anything, just copy /etc/rethinkdb/default.conf.sample into /etc/rethinkdb/instances.d/instance1.conf.

##Compiled Binaries Compiled binary release archives for linux/x86_64 and windows/x86_64 are downloadable from the release page.

##Production

See ./meguca help for server operation
Login into the "admin" with the password "password" and change the password

##Building from source

###All Platforms

Install:
- Go >=1.7
- Node.js >=5.0 (for building the client)

###Linux and OSX

Install:
- GCC or Clang
- make
- ffmpeg >= 3.0 development libraries (libavcodec, libavutil, libavformat, libswscale) compiled with:
  - libvpx
  - libvorbis
  - libopus
  - libtheora
  - libx264
  - libmp3lame
- git
- zip
Run make

###Windows

Install MSYS2
Open MSYS2 shell
Install with pacman:
- mingw-w64-x86_64-ffmpeg
- mingw-w64-x86_64-gcc
- mingw-w64-x86_64-pkg-config
- git
- make
- zip
Navigate to the meguca root directory
Run make

##Development

./meguca or ./meguca debug run the server in development mode
make server and make client build the server and client separately
make watch watches the file system for changes and incrementally rebuilds the client
make update updates all dependencies and fetches new project sources from the master branch
make clean removes files from the previous compilation
make dist_clean in addition to the above removes uploaded files and their thumbnails

###Linux only

make creates a Go workspace in the .build subdirectory. If you don't have a proper Go worksapce set up, you can simply export GOPATH=$(pwd)/.build to temporarily assign .build as your Go workspace in the current shell. This will allow you to use native go commands such as go test and go build.

Documentation

docs/nginx.config.example - ngingx configuration example

Documentation ¶

There is no documentation for this package.

Source Files ¶

View all Source files

main.go

Directories ¶

Path	Synopsis
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.
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.
db Package db handles all core database intercations of the server	Package db handles all core database intercations of the server
imager Package imager handles image, video, etc.	Package imager handles image, video, etc.
assets Package assets manages imager file asset allocation and deallocation	Package assets manages imager file asset allocation and deallocation
parser Package parser parses and verifies user-sent post data	Package parser parses and verifies user-sent post data
server Package server handles client requests for HTML page rendering, JSON and websocket connections	Package server handles client requests for HTML page rendering, JSON and websocket connections
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
templates Package templates generates and stores HTML templates	Package templates generates and stores HTML templates
test Package test contains utility functions used throughout the project in tests	Package test contains utility functions used throughout the project in tests
types Package types contains common shared types used throughout the project	Package types contains common shared types used throughout the project
util Package util contains various general utility functions used throughout the project.	Package util contains various general utility functions used throughout the project.

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