Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add moderation guide #1473

Merged
merged 4 commits into from
Feb 3, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
- [Inscriptions](guides/inscriptions.md)
- [Sat Hunting](guides/sat-hunting.md)
- [Collecting](guides/collecting.md)
- [Moderation](guides/moderation.md)
- [Bounties](bounties.md)
- [Bounty 0: 100,000 sats Claimed!](bounty/0.md)
- [Bounty 1: 200,000 sats Claimed!](bounty/1.md)
Expand Down
51 changes: 51 additions & 0 deletions docs/src/guides/moderation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
Moderation
==========

`ord` includes a block explorer, which you can run locally with `ord server`.

The block explorer allows viewing inscriptions. Inscriptions are user-generated
content, which may be objectionable or unlawful.

It is the responsibility of each individual who runs an ordinal block explorer
instance to understand their responsibilities with respect to unlawful content,
and decide what moderation policy is appropriate for their instance.

In order to prevent particular inscriptions from being displayed on an `ord`
instance, they can be included in a YAML config file, which is loaded with the
`--config` option.

To hide inscriptions, first create a config file, wiht the inscription ID you
want to hide:

```yaml
hidden:
- 0000000000000000000000000000000000000000000000000000000000000000i0
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it's probably obvious to most people, but we could be explicit that this is the inscription id

```

The suggested name for `ord` config files is `ord.yaml`, but any filename can
be used.

Then pass the file to `--config` when starting the server:

`ord --config ord.yaml server`

Note that the `--config` option comes after `ord` but before the `server`
subcommand.

`ord` must be restarted in to load changes to the config file.

`ordinals.com`
--------------

The `ordinals.com` instances use `systemd` to run the `ord server` service,
which is called `ord`, with a config file located at `/var/lib/ord/ord.yaml`.

To hide an inscription on `ordinals.com`:

1. SSH into the server
2. Add the inscription ID to `/var/lib/ord/ord.yaml`
3. Restart the service with `systemctl restart ord`
4. Monitor the restart with `journalctl -u ord`

Currently, `ord` is slow to restart, so the site will not come back online
immediately.
4 changes: 2 additions & 2 deletions docs/src/guides/sat-hunting.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Ordinal Hunting
===============
Sat Hunting
===========

*This guide is out of date. Since it was written, the `ord` binary was changed
to only build the full satoshi index when the `--index-sats` flag is supplied.
Expand Down