diff --git a/.all-contributorsrc b/.all-contributorsrc index 50d69cf155..e2d499126b 100644 --- a/.all-contributorsrc +++ b/.all-contributorsrc @@ -196,7 +196,8 @@ "avatar_url": "https://avatars2.githubusercontent.com/u/20923978?v=4", "profile": "https://github.com/danshilm", "contributions": [ - "code" + "code", + "doc" ] }, { @@ -235,6 +236,15 @@ "contributions": [ "code" ] + }, + { + "login": "flying-sausages", + "name": "flying-sausages", + "avatar_url": "https://avatars1.githubusercontent.com/u/23618693?v=4", + "profile": "https://github.com/flying-sausages", + "contributions": [ + "doc" + ] } ], "badgeTemplate": "-orange.svg\"/>", diff --git a/.gitbook.yaml b/.gitbook.yaml new file mode 100644 index 0000000000..6c5133ed3c --- /dev/null +++ b/.gitbook.yaml @@ -0,0 +1,5 @@ +root: ./docs + +structure: + readme: README.md + summary: SUMMARY.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 99ba8dd3db..0da054764c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -38,7 +38,7 @@ All help is welcome and greatly appreciated. If you would like to contribute to ``` yarn - yarn install + yarn dev ``` - Alternatively you can run using [Docker](https://www.docker.com/) with `docker-compose up -d`. This method does not require installing NodeJS or Yarn on your machine directly. diff --git a/Dockerfile b/Dockerfile index 48bd94d423..8a0190bf8d 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,5 +1,8 @@ FROM node:12.18-alpine AS BUILD_IMAGE +ARG COMMIT_TAG +ENV COMMIT_TAG=${COMMIT_TAG} + COPY . /app WORKDIR /app @@ -25,6 +28,8 @@ COPY --from=BUILD_IMAGE /app/dist ./dist COPY --from=BUILD_IMAGE /app/.next ./.next COPY --from=BUILD_IMAGE /app/node_modules ./node_modules +RUN echo "{\"commitTag\": \"${COMMIT_TAG}\"}" > committag.json + CMD yarn start EXPOSE 5055 diff --git a/README.md b/README.md index 2707710ae3..179a3124f4 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ - +
@@ -36,16 +36,21 @@ - User profiles. - User settings page (to give users the ability to modify their Overseerr experience to their liking). -- Version update notifications in-app. - 4K requests (Includes multi-radarr/sonarr management for media) ## Planned Features -- More notification types (Slack/Telegram/etc.). +- More notification types. - Issues system. This will allow users to report issues with content on your media server. - Local user system (for those who don't use Plex). - Compatibility APIs (to work with existing tools in your system). +## Getting Started + +Check out our documenation for steps on how to install and run Overseerr: + +https://docs.overseerr.dev/getting-started/installation + ## Running Overseerr Currently, Overseerr is only distributed through Docker images. If you have Docker, you can run Overseerr as per: @@ -70,6 +75,7 @@ After running Overseerr for the first time, configure it by visiting the web UI ## Support +- Check out the [Overseerr Documentation](https://docs.overseerr.dev/) before asking for help. Your question might already be in the [FAQ](https://docs.overseerr.dev/support/faq). - You can get support on [Discord](https://discord.gg/PkCWJSeCk7). - You can ask questions in the Help category of our [GitHub Discussions](https://github.com/sct/overseerr/discussions). - Bugs/Feature Requests can be opened via a [GitHub issue](https://github.com/sct/overseerr/issues). @@ -123,13 +129,14 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d