buttcloud/buttpub-landing repository overview

⁠buttpub-landing

a public-facing landing page for your Scuttlebutt pub server

⁠install

as an sbot plugin:

mkdir -p ~/.ssb/node_modules
cd ~/.ssb/node_modules
git clone git://github.com/buttcloud/buttpub-landing buttpub-landing
cd buttpub-landing
npm install
sbot plugins.enable buttpub-landing
# restart sbot

or standalone:

git clone git://github.com/buttcloud/buttpub-landing buttpub-landing
cd buttpub-landing
npm install
./bin.js

⁠usage

to browse landing page, navigate to http://localhost:8901⁠

⁠config

to change buttpub-landing's default options, edit your ~/.ssb/config to have properties like:

{
  "landing": {
    "port": 8901,
    "host": "::"
  }
}

⁠license

The Apache License

Copyright © 2018 Michael Williams

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.