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

Релиз 2023.4 #575

Merged
merged 9 commits into from
Dec 26, 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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ Investbook в сравнении с [Intelinvest](https://intelinvest.ru) и [Sn
Investbook также может быть запущен в [docker](docs/run-by-docker.md).

### Работа с приложением
Запустите приложение через ярлык на рабочем столе Windows, в браузере перейдите по адресу http://localhost
Запустите приложение через ярлык на рабочем столе Windows, в браузере перейдите по адресу http://localhost:2030
и загрузите отчеты брокера (с локального компьютера или из email ящика).

Для удобства приложение допускает:
Expand Down
4 changes: 1 addition & 3 deletions docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,6 @@

#### Настройка приложения, установленного из архива .zip
Эта секция применима к любой операционной системе. Перейдите в директорию установки приложения и измените
настроечный файл `application-conf.properties`. Например, можно изменить порт с 80 на 8080.
Поддерживаются другие настройки
[Spring](https://docs.spring.io/spring-boot/docs/current/reference/html/appendix-application-properties.html).
настроечный файл `application-conf.properties`.


3 changes: 0 additions & 3 deletions docs/developer-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,6 @@ mvn clean compile
Перед запуском приложения средствами IntelliJ IDEA обязательна [компиляция](#компиляция), после которой можно
запустить приложение по кнопке в верхней панели.

На Linux и Mac перед запуском не из под root дополнительно потребуется сменить порт с 80 на свободный больше 1024.
Порт редактируется в файле `src/main/resources/application-conf.properties`, однако делать commit изменения не нужно.

Если у вас другая среда разработки или вы работаете из консоли, то приложение можно запустить без предварительной
компиляции командой:
```
Expand Down
16 changes: 7 additions & 9 deletions docs/install-on-linux.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,20 +19,18 @@
3. Скачать со страницы [проекта](https://github.com/spacious-team/investbook/releases/latest) архив `.zip` и
распаковать в директорию `/opt`.
4. Если вы обновляете приложение, убедитесь, что оно не запущено.
5. Если работаете не под root, то сменить порт в файле `application-conf.properties` с 80 на 8080.
6. Из распакованной папки investbook запустите приложение
5. Из распакованной папки investbook запустите приложение
```shell
$ sh start.sh
```
7. Откроется браузер, отобразится страница приложения.
6. Откроется браузер, отобразится страница приложения.
Если браузер не открылся в течении 5-30 сек (в зависимости от производительности вашего компьютера),
откройте сайт http://localhost (или http://localhost:8080, если меняли порт). Это локальный сайт,
запущенный приложением на вашем компьютере.
8. Если страница не открылась, ознакомьтесь с возможными причинами и [решениями проблем](/src/main/asciidoc/troubleshooting.adoc).
9. Перейти в раздел `Загрузить отчеты брокера`, выбрать отчеты брокера, которые хотите проанализировать, и нажать кнопку
откройте сайт http://localhost:2030. Это локальный сайт, запущенный приложением на вашем компьютере.
7. Если страница не открылась, ознакомьтесь с возможными причинами и [решениями проблем](/src/main/asciidoc/troubleshooting.adoc).
8. Перейти в раздел `Загрузить отчеты брокера`, выбрать отчеты брокера, которые хотите проанализировать, и нажать кнопку
`загрузить`. Или загрузить отчет из email ящика. Или воспользоваться разделом `Форм` для ручного ввода информации.
10. Нажать `Аналитика`. С форматом аналитического отчета можно ознакомиться в [документации](/src/main/asciidoc/index.adoc).
11. По окончании работы нажмите в верхнем правом углу пиктограмму `Завершить`, если желаете выгрузить приложение
9. Нажать `Аналитика`. С форматом аналитического отчета можно ознакомиться в [документации](/src/main/asciidoc/index.adoc).
10. По окончании работы нажмите в верхнем правом углу пиктограмму `Завершить`, если желаете выгрузить приложение
из памяти компьютера. Или оставьте приложение в памяти для быстрого повторного запуска.

#### Обновление приложения
Expand Down
6 changes: 3 additions & 3 deletions docs/install-on-windows-by-zip.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,15 @@
содержать папку bin).
+ Сохранить файл `start.bat`.
1. Если вы обновляете приложение, нужно убедиться, что оно не запущено. Для этого нужно открыть в браузере сайт
`http://localhost` и остановить приложение `Investbook`, нажав в верхнем правом углу пиктограмму `Завершить`, если оно запущено.
`http://localhost:2030` и остановить приложение `Investbook`, нажав в верхнем правом углу пиктограмму `Завершить`, если оно запущено.
Или запустите Диспетчер задач сочетанием клавиш `Ctrl+Shift+Esc` и остановите процесс `Investbook.exe`.
1. Запустить двойным щелчком `start.bat`. Появится консоль, откроется браузер и отобразится страница приложения.
Если браузер не открылся в течении 5-30 сек (в зависимости от производительности вашего компьютера),
откройте сайт `http://localhost` (это локальный сайт, запущенный приложением на вашем компьютере).
откройте сайт `http://localhost:2030` (это локальный сайт, запущенный приложением на вашем компьютере).
1. Если страница не открылась, ознакомьтесь с возможными причинами и [решениями проблем](/src/main/asciidoc/troubleshooting.adoc).
1. Перейти в раздел `Загрузить отчеты брокера`, выбрать отчеты брокера, которые хотите проанализировать, и нажать кнопку
`загрузить`. Или воспользоваться разделом `Форм` для ручного ввода информации.
1. Нажать `Аналитика`. С форматом аналитического отчета можно ознакомиться в [документации](/src/main/asciidoc/index.adoc).
1. По окончании работы нажмите в верхнем правом углу пиктограмму `Завершить`, если желаете выгрузить приложение
из памяти компьютера. Или оставьте приложение в памяти для быстрого повторного запуска (тогда для запуска приложения
достаточно будет открыть браузер и перейти по адресу `http://localhost`).
достаточно будет открыть браузер и перейти по адресу `http://localhost:2030`).
10 changes: 5 additions & 5 deletions docs/install-on-windows.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,20 @@
1. Скачать со страницы [проекта](https://github.com/spacious-team/investbook/releases/latest) установщик `.msi`
и запустить его.
1. Если вы обновляете приложение и в процессе обновления появилось показанное ниже окно - это означает, что запущена
предыдущая версия приложения. Перед нажатием кнопки `ОК` нужно открыть в браузере сайт `http://localhost` и остановить
приложение `Investbook`, нажав в верхнем правом углу пиктограмму `Завершить`. Если сайт не открывается - запустите
Диспетчер задач сочетанием клавиш `Ctrl+Shift+Esc` и остановите процесс `Investbook.exe`.
предыдущая версия приложения. Перед нажатием кнопки `ОК` нужно открыть в браузере сайт `http://localhost:2030` и
остановить приложение `Investbook`, нажав в верхнем правом углу пиктограмму `Завершить`. Если сайт не открывается -
запустите Диспетчер задач сочетанием клавиш `Ctrl+Shift+Esc` и остановите процесс `Investbook.exe`.
![close-app](https://user-images.githubusercontent.com/11336712/109365987-5ec67980-78a3-11eb-8709-cc18dda60554.png)
1. На рабочем столе появится ярлык `Investbook`, запустите его - откроется браузер и отобразится страница приложения.
Если браузер не открылся в течении 5-30 сек (в зависимости от производительности вашего компьютера),
откройте сайт `http://localhost` (это локальный сайт, запущенный приложением на вашем компьютере).
откройте сайт `http://localhost:2030` (это локальный сайт, запущенный приложением на вашем компьютере).
1. Если страница не открылась, ознакомьтесь с возможными причинами и [решениями проблем](/src/main/asciidoc/troubleshooting.adoc).
1. Перейти в раздел `Загрузить отчеты брокера`, выбрать отчеты брокера, которые хотите проанализировать, и нажать кнопку
`Загрузить`. Или загрузите отчет из email ящика. Или воспользоваться разделом `Форм` для ручного ввода информации.
1. Нажать `Аналитика`. С форматом аналитического отчета можно ознакомиться в [документации](/src/main/asciidoc/index.adoc).
1. По окончании работы нажмите в верхнем правом углу пиктограмму `Завершить`, если желаете выгрузить приложение
из памяти компьютера. Или оставьте приложение в памяти для быстрого повторного запуска (тогда для запуска
приложения достаточно будет открыть браузер и перейти по адресу `http://localhost`).
приложения достаточно будет открыть браузер и перейти по адресу `http://localhost:2030`).

#### Установка расширений

Expand Down
8 changes: 4 additions & 4 deletions docs/run-by-docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,18 +31,18 @@ mkdir ~/investbook
#### Запуск Investbook
1. Если используется Windows, запустите Powershell и запустите
```shell
docker run --rm -d -p 80:80 -v /c/users/<имя-windows-пользователя>/investbook:/home/cnb/investbook spaciousteam/investbook
docker run --rm -d -p 2030:2030 -v /c/users/<имя-windows-пользователя>/investbook:/home/cnb/investbook spaciousteam/investbook
```
где вместо `<имя-windows-пользователя>` нужно подставить имя вашего пользователя в Windows.
1. Если используется MacOS или Linux, запустите в терминале
```shell
docker run --rm -d -p 80:80 -v ~/investbook:/home/cnb/investbook spaciousteam/investbook
docker run --rm -d -p 2030:2030 -v ~/investbook:/home/cnb/investbook spaciousteam/investbook
```
Будет загружена и запущена последняя версия Investbook. Далее переходите в браузер и открывайте Investbook
по адресу http://localhost
по адресу http://localhost:2030

#### Обновление Investbook
Если Investbook запущен, остановите его. Для этого откройте http://localhost и сверху-справа нажмите кнопку выхода.
Если Investbook запущен, остановите его. Для этого откройте http://localhost:2030 и сверху-справа нажмите кнопку выхода.
Запустите терминал и удалите текущую версию
```shell
docker rmi spaciousteam/investbook
Expand Down
4 changes: 2 additions & 2 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
</parent>
<groupId>ru.investbook</groupId>
<artifactId>investbook</artifactId>
<version>2023.3</version>
<version>2023.4</version>

<name>investbook</name>
<description>Investor Accounting Book</description>
Expand Down Expand Up @@ -62,7 +62,7 @@

<properties>
<!-- Valid version is (0-255).(0-255).(0-65535) -->
<win.msi.version>23.3</win.msi.version>
<win.msi.version>23.4</win.msi.version>
<java.version>21</java.version>
</properties>

Expand Down
2 changes: 0 additions & 2 deletions src/main/asciidoc/configuration.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,3 @@
== Настройка приложения, установленного из архива .zip
Эта секция применима к любой операционной системе. Перейдите в директорию установки приложения и измените
настроечный файл `application-conf.properties` (находится в директории установки в папке `app`).
Например, можно параметром `server.port` изменить порт с 80 на 8080. Поддерживаются другие настройки
https://docs.spring.io/spring-boot/docs/current/reference/html/application-properties.html#application-properties[Spring Framework].
2 changes: 1 addition & 1 deletion src/main/asciidoc/iis-tax.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Investbook позволяет учитывать доходность ИИС с
Если вы пользуетесь вычетом типа А, то вы должны ежегодно подавать декларацию 3-НДФЛ с указанием информации по ИИС.
Налоговая по итогу проверки переведет на ваш банковский счет вычет. С точки зрения доходности ИИС налоговый вычет можно
расценивать как дополнительный доход, который сгенерирован счетом ИИС и выведен на банковский счет. Для учета вычета,
воспользуйтесь Формами (раздел "События по счетам", действие http://localhost/events/edit-form["Добавить"]). Выберите
воспользуйтесь Формами (раздел "События по счетам", действие http://localhost:2030/events/edit-form["Добавить"]). Выберите
в поле "Операция" значение "Вычет ИИС тип А", укажите дату, номер счета и полученную на банковский счет сумму. Поле
"Описание" будет заполнено автоматически (если будете его редактировать, то оставьте слова "вычет" и "ИИС" - это
слова-маркеры для Investbook). Операция будет сохранена как доход, который выведен со счета ИИС на банковский счет.
Expand Down
4 changes: 2 additions & 2 deletions src/main/asciidoc/troubleshooting.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,15 @@
Если при запуске приложения возникает такая ошибка, значит приложение уже работает (возможно предыдущий запуск еще
не успел открыть окно браузера или вы сами закрыли вкладку браузера).

. Попробуйте запустить браузер по адресу http://localhost
. Попробуйте запустить браузер по адресу http://localhost:2030
. Если предыдущий пункт не помог, запустите диспетчер задач и удалите процесс `Investbook.exe`, после этого повторно
запустите приложение через ярлык.
. Если предыдущий пункт не помог, значит имеется ошибка в работе приложения, которая указана в логе. Лог можно найти
в домашней директории пользователя в файле `investbook\investbook.log`. Изучите ошибку и исправьте ee самостоятельно
или обратитесь с ней в https://t.me/investbook_support[техническую поддержку]. Один из вариантов
самостоятельного решения проблемы описан в разделе "<<delete-db, Исправление ошибок через повторную загрузку отчетов>>".

== Ошибка в логе "Port 80 was already in use"
== Ошибка в логе "Port 2030 was already in use"

Лог расположен в домашней папке пользователя в подпапке `investbook`, файл `investbook.log`. Для исправления ошибки
в папке, в которую установлено Приложение (по умолчанию на Windows устанавливается в `C:\Program Files\Investbook`),
Expand Down