df2

README

df2

df2 is a command-line tool for managing plus optimising the files and database of defacto2.net. It is broken down into five parts.

approve all validated file records that are ready to go live.

clean discover and remove orphan files that exist on the server but have no matching database entries.

config adjust the default settings for this df2 tool.

demozoo interacts with the Demozoo.org API to synchronise data and fetch linked download files.

fix malformed data and generates missing assets from distinct sources.

lookup a website record URL by its database ID or UUID.

new checks Demozoo and #releaseproof submissions, fetches downloads, generate previews and repairs any malformed data.

output generates webpages for groups, peoples and the site map.

proof automates the parsing of files tagged as #releaseproof.

---

A tool to optimise and manage defacto2.net
Copyright © 2020 Ben Garrett
https://github.com/Defacto2/df2

Usage:
  df2 [command]

Available Commands:
  approve     Approve the file records that are ready to go live
  clean       Discover or clean orphan files
  config      Configure the settings for this tool
  demozoo     Interact with Demozoo.org upload submissions
  fix         Fixes database entries and records
  help        Help about any command
  lookup      Lookup the file URL of a database ID or UUID
  new         Handler for files flagged as waiting to go live
  output      JSON, HTML, SQL and sitemap generator
  proof       Handler for files tagged as #releaseproof

Flags:
      --config string   config file (default is config.yaml)
  -h, --help            help for df2
  -q, --quiet           suspend feedback to the terminal
      --version         version for df2

Use "df2 [command] --help" for more information about a command.

Install

Is built on Go v1.14+ and is packaged for the Ubuntu Linux platform.

wget https://github.com/Defacto2/df2/releases/latest/download/df2.deb
dpkg -i df2.deb
df2 --version

Dependencies

The df2 fix text command requires the installation of AnsiLove/C in the system PATH.

WebP support image conversion needs libwebp.

Configuration

To view and test the database and directory configurations.

df2 config info

To change the configuration.

df2 config edit

Documentation

Overview

Copyright © 2019 Ben Garrett <bengarrett77@gmail.com>

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.