-
Notifications
You must be signed in to change notification settings - Fork 556
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
Adding a getting started doc page #745
Open
jparrill
wants to merge
1
commit into
go-shiori:master
Choose a base branch
from
jparrill:feat/getting-started
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,57 @@ | ||
# Getting Started | ||
|
||
Before using `shiori`, make sure it has been installed on your system. By default, `shiori` will store its data in directory `$HOME/.local/share/shiori`. If you want to set the data directory to another location, you can set the environment variable `SHIORI_DIR` (`ENV_SHIORI_DIR` when you are before `1.5.0`) to your desired path. | ||
|
||
<!-- TOC --> | ||
|
||
- [Running Docker Container](#running-docker-container) | ||
- [How to use Shiori](#how-to-use-shiori) | ||
- [Deleting/Stopping Shiori](#deletingstopping-shiori) | ||
|
||
<!-- /TOC --> | ||
|
||
## Running Docker Container | ||
|
||
> If you are not using `shiori` from Docker image, you can skip this section. | ||
|
||
After building or pulling the image, you will be able to start a container from it. To preserve the data, you need to bind the directory for storing database, thumbnails and archive. In this example we're binding the data directory to our current working directory : | ||
|
||
``` | ||
docker run -d --rm --name shiori -p 8080:8080 -v $(pwd):/shiori ghcr.io/go-shiori/shiori | ||
``` | ||
|
||
The above command will: | ||
|
||
- Creates a new container from image `ghcr.io/go-shiori/shiori`. | ||
- Set the container name to `shiori` (option `--name`). | ||
- Bind the host current working directory to `/shiori` inside container (option `-v`). | ||
- Expose port `8080` in container to port `8080` in host machine (option `-p`). | ||
- Run the container in background (option `-d`). | ||
- Automatically remove the container when it stopped (option `--rm`). | ||
|
||
After you've run the container in background, you can access console of the container: | ||
|
||
``` | ||
docker exec -it shiori sh | ||
``` | ||
|
||
Now you can use `shiori` like normal. | ||
|
||
## How to use Shiori | ||
|
||
From this point you have the option to proceed to the [usage section](./Usage.md), where various modes of operation are elaborated upon: | ||
|
||
- [How to use the Web Interface](./Usage.md#using-web-interface) | ||
- [Using the CLI](./Usage.md#using-command-line-interface) | ||
- [Improved import from Pocket](./Usage.md#improved-import-from-pocket) | ||
- [Import from Wallabag](./Usage.md#import-from-wallabag) | ||
|
||
|
||
## Deleting/Stopping Shiori | ||
|
||
If you've finished, you can stop and remove the container by running : | ||
|
||
``` | ||
docker stop shiori | ||
``` | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I have been giving a thought and I believe is better to point the installation to the proper installation docs, so we don't have repeated documentation around. Hopefully we will maintain that properly and up to date and when the documentation site is up an ready it will be easy to navigate through sections. What do you think?