Add an initial (incomplete) man page
I'm writing this in Markdown in order to (hopefully) make it easier to integrate all documentation in a friendly website. Can be converted to mandoc using md2man: https://github.com/sunaku/md2man (I'll probably include a converted version in the repo later)
|3 days ago|
|man||3 days ago|
|src||6 days ago|
|.gitignore||1 month ago|
|Cargo.lock||6 days ago|
|Cargo.toml||1 week ago|
|LICENSE||1 month ago|
|README.md||1 week ago|
This is an early beta-level implementation of a ChiFS Share manager.
See the ChiFS project for more info.
Setting up a Share involves the following steps.
There are no prebuilt binaries at the moment, so for now you’ll need to build everything from source.
Make sure you have the following prerequisites:
Now build ChiFS-Share from source:
git clone https://code.blicky.net/chifs/chifs-share cd chifs-share cargo install --path .
Create a chifs-share.conf:
# Information about your Share. Remember: This will be public! Title This is my super cute share! ContactInfo firstname.lastname@example.org # Directory to share Share /home/user/shared-files # By default, metadata will be written to $Share/.chifs-share/. # Uncomment the following line to store it somewhere else. #Metadata /home/user/.chifs-share # Don't share hidden files Ignore *~ Ignore .* # Include some metadata Meta magic mime
If you want to use your own web server (e.g.
Apache, nginx or
Lighttpd), you should point your web server to the
Share directory and make sure that
/.chifs-share/ points to the correct
Metadata directory. Then run
chifs-share -c chifs-share.conf index and sit
back while it indexes your files.
If you don’t want to bother with that, you can also just run
chifs-share -c chifs-share.conf server to use the built-in web server. It
will listen to
127.0.0.1:9080 by default, but you can change that by adding a
Listen <addr> directive to the configuration file. The built-in server will
automatically index your files and will periodically scan for updates.
Finally, setup a Tor onion service at port 80 and point it to your web server.
In no particular order: